Skip to main content

Get a token by serial number

GET 
/api/web/v1/tokens/sernum/:sernum

Get the token for the specified serial number. Caller requires the TOKENS:VIEW permission.

Request​

Path Parameters

    sernum stringrequired

    The serial number of the token to be retrieved.

Responses​

Successful

Schema

    algorithmType string

    Possible values: [AT, OATH_HOTP, OATH_OCRA, OATH_TOTP, VENDOR]

    The algorithm type used by the token that was created or loaded into the system to generate OTP values.

    allowedActions string[]

    Possible values: [ACTIVATE, REACTIVATE, ACTIVATE_COMPLETE, DELETE, UNLOCK, ENABLE, DISABLE, RESET, ASSIGN, UNASSIGN]

    Actions that can be performed on this token.

    description string

    Optional text describing this token.

    groups string[]

    The UUIDs of groups to which this token belongs. This value is only used for unassigned tokens. Only groups to which the current administrator has access will be returned.

    id string

    The unique UUID assigned to the token when it is created.

    label string

    Optional label to identify an assigned token: a String up to 100 characters.

    lastUsedDate date-time

    The date on which the token was last used for authentication. This value will be null if the token has never been used.

    loadDate date-time

    The date on which the token was created or loaded into the system.

    logo string

    Base-64 encoded logo. If a custom logo is provided by the customer it is returned. Otherwise a system default logo is returned.

    name string

    An optional name for the token.

    platform string

    The mobile device platform on which an Entrust Soft Token was activated.

    registeredForTransactions boolean

    A flag indicating if the Entrust Soft Token has registered for transactions. Only tokens that are registered can perform token push authentication.

    serialNumber string

    The serial number of the token either generated when the token was created or loaded into the system.

    state string

    Possible values: [NEW, ACTIVATING, ACTIVE, INACTIVE, UNASSIGNED]

    The state of the token. For most tokens, only tokens in the ACTIVE state can be used for authentication. Google Authenticator tokens in the ACTIVATING state can also be used for authentication.

    supportsChallengeResponse boolean

    A flag indicating if the Token supports challenge response processing.

    supportsResponse boolean

    A flag indicating if the Token supports response processing.

    supportsSignature boolean

    A flag indicating if the Token supports signature processing.

    supportsUnlock boolean

    A flag indicating if the Token supports unlock processing.

    supportsUnlockTOTP boolean

    A flag indicating if the Token supports unlock using TOTP processing.

    type string

    Possible values: [ENTRUST_PHYSICAL_TOKEN, ENTRUST_SOFT_TOKEN, GOOGLE_AUTHENTICATOR, OATH_PHYSICAL_TOKEN, ENTRUST_LEGACY_TOKEN]

    The type of token specified when the token was created or loaded into the system.

    userId string

    If the token is assigned to a user, this value specifies that user's user id.

Loading...