Skip to main content

Token

Information returned from the service about a token.

Properties

NameTypeDescriptionNotes
algorithm_typestrThe algorithm type used by the token that was created or loaded into the system to generate OTP values.[optional]
allowed_actionsList[str]Actions that can be performed on this token.[optional]
descriptionstrOptional text describing this token.[optional]
groupsList[str]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.[optional]
idstrThe unique UUID assigned to the token when it is created.[optional]
labelstrOptional label to identify an assigned token: a String up to 100 characters.[optional]
last_used_datedatetimeThe date on which the token was last used for authentication. This value will be null if the token has never been used.[optional]
load_datedatetimeThe date on which the token was created or loaded into the system.[optional]
logostrBase-64 encoded logo. If a custom logo is provided by the customer it is returned. Otherwise a system default logo is returned.[optional]
namestrAn optional name for the token.[optional]
platformstrThe mobile device platform on which an Entrust Soft Token was activated.[optional]
registered_for_transactionsboolA flag indicating if the Entrust Soft Token has registered for transactions. Only tokens that are registered can perform token push authentication.[optional]
serial_numberstrThe serial number of the token either generated when the token was created or loaded into the system.[optional]
statestrThe 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.[optional]
supports_challenge_responseboolA flag indicating if the Token supports challenge response processing.[optional]
supports_responseboolA flag indicating if the Token supports response processing.[optional]
supports_signatureboolA flag indicating if the Token supports signature processing.[optional]
supports_unlockboolA flag indicating if the Token supports unlock processing.[optional]
supports_unlock_totpboolA flag indicating if the Token supports unlock using TOTP processing.[optional]
typestrThe type of token specified when the token was created or loaded into the system.[optional]
user_idstrIf the token is assigned to a user, this value specifies that user's user id.[optional]

Example