Skip to main content

Get an OTP credential

GET 
/nevisidm/api/core/v1/:clientExtId/users/:userExtId/otp-credentials/:extId

Since: 8.2605.0, 9.2605.0

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

Returns a specific OTP card credential identified by its external ID, belonging to the specified user.

The response includes the credential metadata (state, timestamps, login statistics) and the OTP card data, which encodes the grid of one-time passwords in a compact format (rows|cols|counters|card).

In self-admin mode, the user can retrieve their own OTP credential. 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
    extId stringrequired

    External ID of the OTP credential.

    Example: otp-123

Responses​

OTP credential retrieved 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.

    otp string

    Indexed table of small passwords. The parts separated by '|' sign by name: rows|cols|counters|card(|latestChallenge).

Loading...
Last updated on