PublicKeyCredentialRequestOptions.rpId

Secure context
This 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 1
The definition of 'rpId' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
rpId
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera Full support YesSafari ? WebView Android ? Chrome Android ? Edge Mobile ? Firefox Android ? Opera Android Full support YesSafari iOS ? Samsung Internet Android ?

Legend

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

See also

Document Tags and Contributors

Contributors to this page: mdnwebdocs-bot, SphinxKnight
Last updated by: mdnwebdocs-bot,