ZITADEL Docs
APIsCore ResourcesV2User

Start the registration of passkey for a user

Start the registration of a passkey for a user, as a response the public key credential creation options are returned, which are used to verify the passkey..

POST
/v2/users/{user_id}/passkeys

Path Parameters

user_id*string

Request Body

application/json

code?|
authenticator?string
Value in"PASSKEY_AUTHENTICATOR_UNSPECIFIED" | "PASSKEY_AUTHENTICATOR_PLATFORM" | "PASSKEY_AUTHENTICATOR_CROSS_PLATFORM"
domain?string
[key: string]?never

Response Body

application/json

curl -X POST "https://loading/v2/users/string/passkeys" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "sequence": 0,
    "changeDate": "2023-01-15T01:30:15.01Z",
    "resourceOwner": "string",
    "creationDate": "2023-01-15T01:30:15.01Z"
  },
  "passkeyId": "string",
  "publicKeyCredentialCreationOptions": {
    "property1": {},
    "property2": {}
  }
}

Was this page helpful?

Start the registration of a u2f token for a user

Start the registration of a u2f token for a user, as a response the public key credential creation options are returned, which are used to verify the u2f token..

Unlock user

Unlock user: The state of the user will be changed to 'active'. The user will be able to log in again. The endpoint returns an error if the user is not in the state 'locked'.