Skip to Content

Begin WebAuthn security key registration.

Generates a WebAuthn challenge and registration options to enroll a new hardware security key or passkey for 2-factor authentication. A mailbox bearer or system key acting under its credential must re-prove the current password when an active password credential exists. Account and unacted system administrators, and password-less provisioning, are exempt.

openemail.securityKeys.beginRegistration(
  identityId: string,
  body: SecurityKeysBeginRegistrationBody,
  options?: CallOptions,
): ApiPromise<WebauthnRegistrationOptions>

It calls POST /identities/{identityId}/webauthn/registrations: Begin WebAuthn security key registration in the API reference.

Example

const webauthnRegistrationOptions = await openemail.securityKeys.beginRegistration(identityId, { rpId: '…' })

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
bodySecurityKeysBeginRegistrationBodyThe request's body.

Options

It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, WebauthnRegistrationOptions. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400password_required: a mailbox session must re-prove its active password
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
403invalid_password
404Mailbox not found or not accessible to this principal
409no_password_credential: the password was removed during re-proof; restart registration
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
429rate_limited
503temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

SecurityKeysBeginRegistrationBody

/** The body of `securityKeys.beginRegistration`. */
type SecurityKeysBeginRegistrationBody = {
  /** The mailbox's current password. Required for a mailbox session (including a relayed session) when an active password exists; omitted for administrators or password-less provisioning */
  currentPassword?: string
  /** Relying Party ID (domain hostname) */
  rpId: string
}

It names these types of the API, each on a page of its own: WebauthnRegistrationOptions.