User Authenticators

Download OpenAPI specification:Download

Manage user authenticators, such as WebAuthn credentials, TOTP authenticators, and more. These APIs allow you to view and manage the authenticators that were registered for a given user.

User authenticators

List of authenticators for a user.

Required permissions: organizations:read, orgs:read, apps:read, [appId]:read, authenticators:read.

SecurityOAuth2: ClientAccessToken

Request

path Parameters

userId

required

string

ID of the user

Responses

200

List of user authenticators

get/v1/users/{userId}/authenticators

Request samples

Response samples

application/json

[{"id": "string",
"type": "totp",
"name": "string",
"status": "Active",
"user_id": "string",
"registered_at": "2019-08-24T14:15:22Z",
"last_successful_authentication": "2019-08-24T14:15:22Z",
"last_failed_authentication": "2019-08-24T14:15:22Z",
"last_accessed_app_id": "string",
"last_accessed_org_id": "string",
"extra_data": {"email": "string",
"verified": true,
"verified_at": "2019-08-24T14:15:22Z"
}
}
]

Unlock authenticator

Unlocks a user's authenticator by clearing all attempts data for the locked user.

Required permissions: apps:edit, [appId]:edit, authenticators:edit.

SecurityOAuth2: ClientAccessToken

Request

path Parameters

user_id required	string ID of the user
authenticator_type required	string Authenticator type to unlock. Enum: "password" "totp"

Responses

204

User Unlocked

post/v1/users/{user_id}/authenticators/{authenticator_type}/unlock

Request samples