Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The rp
property of the PublicKeyCredentialCreationOptions
dictionary is an object describing the relying party which requested the credential creation (via navigator.credentials.create()
).
Syntax
relyingPartyObj = publicKeyCredentialCreationOptions.rp
Properties
icon
Optional- An URL as a
USVString
value which points to an image resource which can be the logo/icon of the relying party. id
- A
DOMString
uniquely identifying a relying party. The default value of this property is the domain of the current document (e.g."login.example.com"
). It may be overridden with a suffix of the current domain (e.g."example.com"
). name
- A
DOMString
giving a human-readable name for the relying party. This property is intended for display (e.g."Example CORP"
).
Examples
var publicKey = { challenge: /* from the server */, rp: { name: "Example CORP", id : "login.example.com", icon: "https://login.example.com/login.ico" }, user: { id: new Uint8Array(16), name: "jdoe@example.com", displayName: "John Doe" }, pubKeyCredParams: [ { type: "public-key", alg: -7 } ] }; navigator.credentials.create({ publicKey }) .then(function (newCredentialInfo) { // send attestation response and client extensions // to the server to proceed with the registration // 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 'rp' in that specification. |
Recommendation | Initial definition. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
rp | Chrome Full support 67 | Edge Full support ≤79 | Firefox Full support 60 | IE ? | Opera Full support Yes | Safari Full support 13 | WebView Android No support No | Chrome Android Full support 67 | Firefox Android ? | Opera Android Full support Yes | 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.