Skip to main content

Update a recovery code credential

PATCH 
/nevisidm/api/core/v1/:clientExtId/users/:userExtId/recovery-codes

Since: 2.78.0

Required permission(s): AccessControl.CredentialView,AccessControl.CredentialModify or SelfAdmin Role

Partially updates the recovery code credential of the user with the given external ID, belonging to the specified client. Only provided fields will be updated.

The credential state and modification comment can be changed. The recovery codes themselves cannot be modified through this endpoint.

Supports self-admin mode with JWT token validation.

Request​

Path Parameters

    clientExtId stringrequired

    External ID of the client.

    Example: client-123
    userExtId stringrequired

    External ID of the user.

    Example: user-123

Body

required
    stateName string

    Possible values: [initial, active, disabled, archived]

    The new state of the credential.

    modificationComment string

    Textual comment regarding the modification.

    version int32

    Version used for optimistic locking.

Responses​

Recovery code credential updated successfully

Schema
    created string

    Creation date of the entity.

    lastModified string

    Date when the entity was last modified.

    version int32

    Version used for optimistic locking.

    extId string

    The external ID of the credential.

    userExtId string

    The external ID of the user to whom the credential belongs.

    policyExtId string

    The external ID of the used policy.

    stateName string

    Possible values: [initial, active, tmp-locked, fail-locked, reset-code, admin-changed, disabled, archived]

    The state of the credential. Available values: initial, active, tmp-locked, fail-locked, reset-code, admin-changed, disabled, archived.

    stateChangeReason string

    Reason for the last state change of the password.

    stateChangeDetail string

    Reason detail for the last state change of the password.

    lastSuccessfulLoginDate string

    Timestamp of last successful login.

    successfulLoginCount int32

    Counts successful logins with this credential since last initialization or reset.

    lastFailedLoginDate string

    Date of last non-technical login failure, for example, wrong password.

    failedLoginCount int32

    Counts non-technical login failures since the last successful login, initialization or reset.

    modificationComment string

    Textual comment regarding the last modification.

    type string

    Possible values: [Password, Certificate, SecurID User Mapping, Ticket Authorization, Safeword User Mapping, OTP Card, Temporary Strong Password, Generic Credential, Kerberos, mTan, Vasco, PUK, URL Ticket, DevicePassword, MobileSignature, SAML Federation, Security Questions, Context Password, OATH, FIDO UAF Authenticator, Recovery Code, FIDO2 Authenticator]

    Type of credential.

    validity object

    Describes the validity period of the password.

    from string

    Start date of the entity's validity in ISO format.

    to string

    End date of the entity's validity in ISO format.

    codes object[]

    List of 16 recovery codes and their usage dates. Each code can only be used once.

  • Array [
    • code string

    The recovery code value. Each code follows the format of four groups of four alphanumeric characters separated by hyphens.

    usageDate string

    The date when the code was used in ISO format. Null if the code has not been used yet.

  • ]
Loading...
Last updated on