Sign in

v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
SDK

Gets passkey authentication options

get/sdk/{environmentId}/users/passkeys/authenticate

Path parameters

environmentIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the environment

Query parameters

relatedOriginRpIdstring
Example:example.com

The Relying Party ID (rpID) to use as the passkey challenge rpID when authenticating from a related origin (Related Origin Requests). The canonical form is a bare hostname such as example.com; a full origin like https://example.com is also accepted and resolves to the same rpID. When omitted, the rpID is derived from the request's Origin header.

Response

returns passkey authentication options

challengestring required
timeoutnumber

Timeout in milliseconds

rpIdstring
userVerification'discouraged' | 'preferred' | 'required'
hints'hybrid' | 'security-key' | 'client-device'

Example response

{
  "challenge": "An example name",
  "rpId": "An example name"
}