PublicKeyCredentialCreationOptionsJSON

A variant of PublicKeyCredentialCreationOptions suitable for JSON transmission to the browser to (eventually) get passed into navigator.credentials.create(...) in the browser.

This should eventually get replaced with official TypeScript DOM types when WebAuthn Level 3 types eventually make it into the language:

interface PublicKeyCredentialCreationOptionsJSON {

attestation?: AttestationConveyancePreference;

attestationFormats?: AttestationFormat[];

authenticatorSelection?: AuthenticatorSelectionCriteria;

challenge: Base64URLString;

excludeCredentials?: PublicKeyCredentialDescriptorJSON[];

extensions?: AuthenticationExtensionsClientInputs;

hints?: PublicKeyCredentialHint[];

pubKeyCredParams: PublicKeyCredentialParameters[];

rp: PublicKeyCredentialRpEntity;

timeout?: number;

user: PublicKeyCredentialUserEntityJSON;

}

§Properties

attestation?: AttestationConveyancePreference

[src]

How the attestation statement should be transported.

attestationFormats?: AttestationFormat[]

[src]

The attestation statement formats that the Relying Party will accept.

authenticatorSelection?: AuthenticatorSelectionCriteria

[src]

Criteria for authenticator selection.

challenge: Base64URLString

[src]

A server-generated challenge in base64url format.

excludeCredentials?: PublicKeyCredentialDescriptorJSON[]

[src]

Credentials that the authenticator should not create a new credential for.

extensions?: AuthenticationExtensionsClientInputs

[src]

Additional parameters requesting additional processing by the client and authenticator.

hints?: PublicKeyCredentialHint[]

[src]

Hints about what types of authenticators the user might want to use.

pubKeyCredParams: PublicKeyCredentialParameters[]

[src]

Information about desired properties of the credential to be created.

rp: PublicKeyCredentialRpEntity

[src]

Information about the Relying Party responsible for the request.

timeout?: number

[src]

Time in milliseconds that the caller is willing to wait for the operation to complete.

user: PublicKeyCredentialUserEntityJSON

[src]

Information about the user account for which the credential is being created.