Skip to main content

Authenticate with a recovery code

POST 
/nevisidm/api/auth/v1/:clientExtId/users/:userExtId/recovery-codes/login

Since: 2.78.0

Required permission(s): AccessControl.CredentialView,AccessControl.CredentialModify,AccessControl.CredentialChangeState

Validates the provided recovery code against the user's active recovery code credential.

The recovery code must be in an active state and within its validity period. Each code is single-use: once authentication succeeds, the code is consumed and cannot be used again. If authentication fails due to an incorrect code, the failure is recorded on the credential.

Returns 204 on successful authentication. Returns an error if the code is invalid, already used, the credential is not active, the credential has expired, or the required permissions are missing.

Request​

Responses​

Authentication successful. The recovery code has been consumed.

Last updated on