Skip to Content

Finish WebAuthn security key registration.

Verifies the browser WebAuthn attestation response and stores the enrolled security key.

openemail.securityKeys.finishRegistration(
  identityId: string,
  body: SecurityKeysFinishRegistrationBody,
  options?: CallOptions,
): ApiPromise<WebauthnCredential>

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

Example

const webauthnCredential = await openemail.securityKeys.finishRegistration(identityId, {
  rpId: '…',
  origin: '…',
  response: { clientDataJSON: '…', attestationObject: '…' },
})

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
bodySecurityKeysFinishRegistrationBodyThe 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, WebauthnCredential. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed, invalid_origin, challenge_expired, webauthn_failed, or duplicate_credential
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox not found or not accessible to this principal
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
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

SecurityKeysFinishRegistrationBody

/** The body of `securityKeys.finishRegistration`. */
type SecurityKeysFinishRegistrationBody = {
  /** User-chosen label for the security key (e.g. 'YubiKey 5') */
  name?: string
  /** Origin URL of the web page where ceremony took place */
  origin: string
  response: SecurityKeysFinishRegistrationBodyResponse
  /** Relying Party ID (domain hostname) */
  rpId: string
}

SecurityKeysFinishRegistrationBodyResponse

/** The API's `SecurityKeysFinishRegistrationBodyResponse`, as the document describes it. */
type SecurityKeysFinishRegistrationBodyResponse = {
  /** Base64url-encoded attestationObject */
  attestationObject: string
  /** Base64url-encoded clientDataJSON */
  clientDataJSON: string
  /** Supported authenticator transports (e.g. ['usb', 'nfc']) */
  transports?: string[]
}

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