Skip to main content

Create a temporary strong password credential

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

Since: 8.2511.0

Required permission(s): AccessControl.CredentialCreate

Creates a new temporary strong password credential for the specified user.

The password is generated automatically by the server according to the configured policy. If a policy is specified, it must be of type TempStrongPasswordPolicy. If omitted, the default temporary strong password policy configured for the client is used.

Depending on the policy configuration, the response body may contain a tempStrongPassword field holding the plaintext password fragment that should be delivered to the user through a secure out-of-band channel (e.g. SMS or email). If the policy does not expose the fragment, the response body is absent and only the Location header is returned.

A Location header pointing to the newly created credential is always included in the response.

Each user can have at most one temporary strong password credential. Creating a second one requires deleting the existing credential first.

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
    extId string

    The external ID of the credential. If omitted, one will be generated automatically.

    policyExtId string

    The external ID of the policy to apply to this credential.

    stateName string

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

    The initial state of the credential.

Responses​

Temporary strong password credential created successfully

Response Headers
  • Location any

    URL of the created resource

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