PublicKeyCredentialCreationOptions

このロケールの翻訳が存在しないため、英語バージョンのコンテンツを表示しています。 Help us translate this article!

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

The PublicKeyCredentialCreationOptions dictionary of the Web Authentication API holds options passed to navigators.credentials.create() in order to create a PublicKeyCredential.

Properties

PublicKeyCredentialCreationOptions.rp
An object describing the relying party which requested the credential creation.
PublicKeyCredentialCreationOptions.user
An object describing the user account for which the credential is generated.
PublicKeyCredentialCreationOptions.challenge
A BufferSource, emitted by the relying party's server and used as a cryptographic challenge. This value will be signed by the authenticator and the signature will be sent back as part of AuthenticatorAttestationResponse.attestationObject.
PublicKeyCredentialCreationOptions.pubKeyCredParams
An Array of element which specify the desired features of the credential, including its type and the algorithm used for the cryptographic signature operations. This array is sorted by descending order of preference.
PublicKeyCredentialCreationOptions.timeout Optional
A numerical hint, in milliseconds, which indicates the time the caller is willing to wait for the creation operation to complete. This hint may be overridden by the browser.
PublicKeyCredentialCreationOptions.excludeCredentials Optional
An Array of descriptors for existing credentials. This is provided by the relying party to avoid creating new public key credentials for an existing user who already have some.
PublicKeyCredentialCreationOptions.authenticatorSelection Optional
An object whose properties are criteria used to filter out the potential authenticators for the creation operation.
PublicKeyCredentialCreationOptions.attestation Optional
A String which indicates how the attestation (for the authenticator's origin) should be transported.
PublicKeyCredentialCreationOptions.extensions Optional
An object with several client extensions' inputs. Those extensions are used to request additional processing (e.g. dealing with legacy FIDO APIs credentials, prompting a specific text on the authenticator, etc.).

Methods

None.

Examples

// some examples of COSE algorithms
const cose_alg_ECDSA_w_SHA256 = -7;
const cose_alg_ECDSA_w_SHA512 = -36;

var createCredentialOptions = {
    // Format of new credentials is publicKey
    publicKey: {
        // Relying Party
        rp: {
            name: "Example CORP",
            id: "login.example.com",
            icon: "https://login.example.com/login.ico"
        },
        // Cryptographic challenge from the server
        challenge: new Uint8Array(26), 
        // User
        user: {
            id: new Uint8Array(16),
            name: "john.p.smith@example.com",
            displayName: "John P. Smith",
        },
        // Requested format of new keypair
        pubKeyCredParams: [{
            type: "public-key",
            alg: cose_alg_ECDSA_w_SHA256,
        }],
        // Timeout after 1 minute
        timeout: 60000,
        // Do not send the authenticator's origin attestation
        attestation: "none",
        extensions: {
          uvm: true,
          exts: true
        },
        // Filter out authenticators which are bound to the device
        authenticatorSelection:{
          authenticatorAttachment: "cross-platform",
          requireResidentKey: true,
          userVerification: "preferred"
        },
        // Exclude already existing credentials for the user
        excludeCredentials: [
          {
            type: "public-key",
            // the id for john.doe@example.com
            id  : new Uint8Array(26) /* this actually is given by the server */
          },
          {
            type: "public-key",
            // the id for john-doe@example.com
            id : new Uint8Array(26) /* another id */
          }
        ]
    }
};

// Create the new credential with the options above
navigator.credentials.create(createCredentialOptions)
  .then(function (newCredentialInfo) {
    var attestationResponse = newCredentialInfo.response;
    var clientExtensionsOutputs = newCredentialInfo.getClientExtensionsResults();

    // Send the response to the relying party server
    // it will verify the content and integrity before
    // creating a new credential

  }).catch(function (err) {
    // Deal with any error properly
    console.error(err);
  });;

Specifications

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

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
PublicKeyCredentialCreationOptions
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera Full support YesSafari ? WebView Android No support NoChrome Android Full support 67Firefox Android ? Opera Android Full support YesSafari iOS ? Samsung Internet Android ?
attestation
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera ? Safari ? WebView Android No support NoChrome Android Full support 67Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?
authenticatorSelection
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera ? Safari ? WebView Android No support NoChrome Android Full support 67Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?
challenge
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera ? Safari ? WebView Android No support NoChrome Android Full support 67Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?
excludeCredentials
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera ? Safari ? WebView Android No support NoChrome Android Full support 67Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?
extensions
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera ? Safari ? WebView Android No support NoChrome Android Full support 67Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?
pubKeyCredParams
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera ? Safari ? WebView Android No support NoChrome Android Full support 67Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?
rp
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera Full support YesSafari ? WebView Android No support NoChrome Android Full support 67Firefox Android ? Opera Android Full support YesSafari iOS ? Samsung Internet Android ?
timeout
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera ? Safari ? WebView Android No support NoChrome Android Full support 67Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?
user
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera ? Safari ? WebView Android No support NoChrome Android Full support 67Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android ?

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.

See also