CredentialManagementAPI
Types
attestationConveyancePreference
typeattestationConveyancePreference=| @as("direct")Direct| @as("enterprise")Enterprise| @as("indirect")Indirect| @as("none")NoneauthenticationExtensionsClientInputs
typeauthenticationExtensionsClientInputs= {mutableminPinLength?:bool,mutablehmacCreateSecret?:bool,mutableappid?:string,mutablecredProps?:bool,mutableprf?:authenticationExtensionsPRFInputs,}Record fields
minPinLength
option< bool >
hmacCreateSecret
option< bool >
appid
option< string >
credProps
option< bool >
prf
option<authenticationExtensionsPRFInputs >
authenticationExtensionsPRFInputs
typeauthenticationExtensionsPRFInputs= {mutableeval?:authenticationExtensionsPRFValues,mutableevalByCredential?:WebAPI.Prelude.any,}Record fields
eval
option<authenticationExtensionsPRFValues >
evalByCredential
option<WebAPI.Prelude.any >
authenticationExtensionsPRFValues
typeauthenticationExtensionsPRFValues= {mutablefirst:WebAPI.Prelude.bufferSource,mutablesecond?:WebAPI.Prelude.bufferSource,}Record fields
second
option<WebAPI.Prelude.bufferSource >
authenticatorAttachment
typeauthenticatorAttachment=| @as("cross-platform")CrossPlatform| @as("platform")PlatformauthenticatorSelectionCriteria
typeauthenticatorSelectionCriteria= {mutableauthenticatorAttachment?:authenticatorAttachment,mutableresidentKey?:residentKeyRequirement,mutablerequireResidentKey?:bool,mutableuserVerification?:userVerificationRequirement,}Record fields
authenticatorAttachment
option<authenticatorAttachment >
residentKey
option<residentKeyRequirement >
requireResidentKey
option< bool >
userVerification
option<userVerificationRequirement >
authenticatorTransport
typeauthenticatorTransport=| @as("ble")Ble| @as("hybrid")Hybrid| @as("internal")Internal| @as("nfc")Nfc| @as("usb")Usbcredential
typecredential= {id:string,type_:string}Record fields
credentialCreationOptions
typecredentialCreationOptions= {mutablesignal?:WebAPI.EventAPI.abortSignal,mutablepublicKey?:publicKeyCredentialCreationOptions,}Record fields
signal
option<WebAPI.EventAPI.abortSignal >
publicKey
option<publicKeyCredentialCreationOptions >
credentialMediationRequirement
typecredentialMediationRequirement=| @as("conditional")Conditional| @as("optional")Optional| @as("required")Required| @as("silent")SilentcredentialRequestOptions
typecredentialRequestOptions= {mutablemediation?:credentialMediationRequirement,mutablesignal?:WebAPI.EventAPI.abortSignal,mutablepublicKey?:publicKeyCredentialRequestOptions,}Record fields
mediation
option<credentialMediationRequirement >
signal
option<WebAPI.EventAPI.abortSignal >
publicKey
option<publicKeyCredentialRequestOptions >
credentialsContainer
typecredentialsContainer= {}Module
There are methods and helpers defined in CredentialsContainer.
publicKeyCredentialCreationOptions
typepublicKeyCredentialCreationOptions= {mutablerp:publicKeyCredentialRpEntity,mutableuser:publicKeyCredentialUserEntity,mutablechallenge:WebAPI.Prelude.bufferSource,mutablepubKeyCredParams:array<publicKeyCredentialParameters,>,mutabletimeout?:int,mutableexcludeCredentials?:array<publicKeyCredentialDescriptor,>,mutableauthenticatorSelection?:authenticatorSelectionCriteria,mutableattestation?:attestationConveyancePreference,mutableextensions?:authenticationExtensionsClientInputs,}Record fields
challenge
pubKeyCredParams
array<publicKeyCredentialParameters >
timeout
option< int >
excludeCredentials
option< array<publicKeyCredentialDescriptor > >
authenticatorSelection
option<authenticatorSelectionCriteria >
attestation
option<attestationConveyancePreference >
extensions
option<authenticationExtensionsClientInputs >
publicKeyCredentialDescriptor
typepublicKeyCredentialDescriptor= {mutabletype_:publicKeyCredentialType,mutableid:WebAPI.Prelude.bufferSource,mutabletransports?:array<authenticatorTransport>,}Record fields
transports
option< array<authenticatorTransport > >
publicKeyCredentialEntity
typepublicKeyCredentialEntity= {mutablename:string}Record fields
name
string
publicKeyCredentialParameters
typepublicKeyCredentialParameters= {mutabletype_:publicKeyCredentialType,mutablealg:int,}Record fields
alg
int
publicKeyCredentialRequestOptions
typepublicKeyCredentialRequestOptions= {mutablechallenge:WebAPI.Prelude.bufferSource,mutabletimeout?:int,mutablerpId?:string,mutableallowCredentials?:array<publicKeyCredentialDescriptor,>,mutableuserVerification?:userVerificationRequirement,mutableextensions?:authenticationExtensionsClientInputs,}Record fields
challenge
timeout
option< int >
rpId
option< string >
allowCredentials
option< array<publicKeyCredentialDescriptor > >
userVerification
option<userVerificationRequirement >
extensions
option<authenticationExtensionsClientInputs >
publicKeyCredentialRpEntity
typepublicKeyCredentialRpEntity= {mutablename:string,mutableid?:string,}Record fields
name
string
id
option< string >
publicKeyCredentialType
typepublicKeyCredentialType= @as("public-key")PublicKeypublicKeyCredentialUserEntity
typepublicKeyCredentialUserEntity= {mutablename:string,mutableid:WebAPI.Prelude.bufferSource,mutabledisplayName:string,}Record fields
name
string
displayName
string
residentKeyRequirement
typeresidentKeyRequirement=| @as("discouraged")Discouraged| @as("preferred")Preferred| @as("required")RequireduserVerificationRequirement
typeuserVerificationRequirement=| @as("discouraged")Discouraged| @as("preferred")Preferred| @as("required")Required