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

Browser compatibility

BCD tables only load in the browser

See also