Web/API/PublicKeyCredentialRequestOptions/rpId

Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The rpId property, of the PublicKeyCredentialRequestOptions dictionary, is an optional property which indicates the relying party's identifier as a USVString. Its value can only be a suffix of the current origin's domain. For example, if you are browsing on foo.example.com, the rpId value may be "example.com" but not "bar.org" or "baz.example.com".

This property is optional. If it is not explicitely provided, the user agent will use the value of the current origin's domain.

Note: An analogous option exists for the creation operation (navigators.credentials.create()), see the id property of PublicKeyCredentialCreationOptions.rp.

Syntax

rpId = publicKeyCredentialRequestOptions.rpId

Value

A USVString for the identifier of the relying party. Its value can only be a suffix of the current origin's domain.

Examples

var options = {
  challenge: new Uint8Array([/* bytes sent from the server */]),
  rpId: "example.com" // will only work if the current domain
                      // is something like foo.example.com
};

navigator.credentials.get({ "publicKey": options })
    .then(function (credentialInfoAssertion) {
    // send assertion response back to the server
    // to proceed with the control of the credential
}).catch(function (err) {
     console.error(err);
});

Specifications

Specification	Status	Comment
Web Authentication: An API for accessing Public Key Credentials Level 1The definition of 'rpId' in that specification.	Recommendation	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`rpId` Experimental'	Chrome Full support 67	Edge Full support ≤79	Firefox Full support 60	IE No support No	Opera Full support 54	Safari Full support 13	WebView Android Full support 67	Chrome Android Full support 67	Firefox Android ?	Opera Android Full support 48	Safari iOS Full support 13.3	Samsung Internet Android No support No

Legend

Full support: Full support
No support: No support
Compatibility unknown: Compatibility unknown
Experimental. Expect behavior to change in the future.': Experimental. Expect behavior to change in the future.