/gate/passkeys/signin/beginBegin Passkey Sign-In
Initiates WebAuthn passkey authentication for an end-user by returning an assertion challenge.
The challenge is presented to the client-side WebAuthn API to prompt the user's registered authenticator; the resulting signed assertion is submitted to the finish endpoint.
This endpoint is app-layer-unauthenticated — no existing JWT is required to begin passkey sign-in.
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| string <email> | The end user's email address. When given, Omit it for a discoverable-credential sign-in, where the browser offers every passkey it holds for this site. |
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 404 | K9O_END_USER_NOT_FOUND | No account was found for the provided identity. |
| data * | object | WebAuthn authentication options ( Pass them to the browser, for example to |
| rpId * | string | The relying party id the passkey must be bound to, set by the deployment. |
| challenge * | string | A random challenge, base64url. It is held for this ceremony and works once; pass the options to the browser unchanged. |
| allowCredentials * | object[] | The passkeys of the end user named by Empty when no email was sent, or when that address has no passkeys: the browser then offers any passkey it holds for this site. |
| id * | string | The credential id, base64url. |
| transports * | string[] | How the browser can reach the authenticator, as the authenticator reported at registration ( |
| type * | "public-key" | The credential type. Always |
| timeout * | integer | How long the browser may wait for the end user, in milliseconds. Always 60000. |
| userVerification * | "preferred" | User verification (biometric or PIN) is asked for. Sign-in/finish requires that it was done. |
| meta * | any | Request metadata: cost, timing and the request and trace ids. |
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.gate.passkeys.signIn.begin({
email: '[email protected]'
})Showing example in TypeScript
{
"email": "[email protected]"
}{
"data": {
"rpId": "string",
"challenge": "string",
"allowCredentials": [
{
"id": "string",
"transports": [
"string"
],
"type": "public-key"
}
],
"timeout": 0,
"userVerification": "preferred"
}
}