Skip to Content

The WebauthnRegistrationOptions type of the TypeScript SDK, which securityKeys.beginRegistration take or answer.

type WebauthnRegistrationOptions = {
  attestation: 'none'
  authenticatorSelection: WebauthnRegistrationOptionsAuthenticatorSelection
  challenge: string
  excludeCredentials: WebauthnRegistrationOptionsExcludeCredentialsItem[]
  pubKeyCredParams: WebauthnRegistrationOptionsPubKeyCredParamsItem[]
  rp: WebauthnRegistrationOptionsRp
  timeout: number
  user: WebauthnRegistrationOptionsUser
}

Fields

FieldTypeDescription
attestation'none'Attestation conveyance preference
authenticatorSelectionWebauthnRegistrationOptionsAuthenticatorSelection
challengestringBase64url-encoded one-time challenge
excludeCredentialsWebauthnRegistrationOptionsExcludeCredentialsItem[]Credentials to exclude to prevent duplicate enrollment
pubKeyCredParamsWebauthnRegistrationOptionsPubKeyCredParamsItem[]Supported cryptographic algorithms
rpWebauthnRegistrationOptionsRp
timeoutnumberCeremony timeout in milliseconds
userWebauthnRegistrationOptionsUser

Used by

MethodWhat it does
securityKeys.beginRegistrationBegin WebAuthn security key registration

On this page