Skip to main content

Reset the temporary strong password

POST 
/nevisidm/api/core/v1/:clientExtId/users/:userExtId/tempstrong-password/reset

Since: 8.2511.0

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

Resets the temporary strong password for the specified user, generating a new server-side password and resetting the credential state to initial.

The operation will fail if the reset count has reached the maximum allowed by the configured PUK policy.

Depending on the policy configuration, the response may contain a tempStrongPassword field holding the new plaintext password fragment for out-of-band delivery to the user. If the policy does not expose the fragment, 204 No Content is returned instead of a response body.

In self-admin mode, a valid JWT token must be provided in the X-Token request header.

Request​

Path Parameters

    clientExtId stringrequired

    External ID of the client.

    Example: client-123
    userExtId stringrequired

    External ID of the user.

    Example: user-123

Responses​

Temporary strong password reset successfully. Response body is absent if the policy does not expose the password fragment.

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.

    tempStrongPassword string

    The hashed temporary strong password value with the message digest algorithm prefix, or the plaintext password fragment when returned by a create or reset operation.

    resetCount int32

    The number of times the credential has been reset.

Loading...
Last updated on