Skip to main content

Token

Information returned from the service about a token.

Properties

NameTypeDescriptionNotes
algorithmTypeAlgorithmTypeEnumThe algorithm type used by the token that was created or loaded into the system to generate OTP values.[optional]
allowedActionsList<AllowedActionsEnum>Actions that can be performed on this token.[optional]
descriptionStringOptional text describing this token.[optional]
groupsList<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.[optional]
idStringThe unique UUID assigned to the token when it is created.[optional]
labelStringOptional label to identify an assigned token: a String up to 100 characters.[optional]
lastUsedDateOffsetDateTimeThe date on which the token was last used for authentication. This value will be null if the token has never been used.[optional]
loadDateOffsetDateTimeThe date on which the token was created or loaded into the system.[optional]
logoStringBase-64 encoded logo. If a custom logo is provided by the customer it is returned. Otherwise a system default logo is returned.[optional]
nameStringAn optional name for the token.[optional]
platformStringThe mobile device platform on which an Entrust Soft Token was activated.[optional]
registeredForTransactionsBooleanA flag indicating if the Entrust Soft Token has registered for transactions. Only tokens that are registered can perform token push authentication.[optional]
serialNumberStringThe serial number of the token either generated when the token was created or loaded into the system.[optional]
stateStateEnumThe 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]
supportsChallengeResponseBooleanA flag indicating if the Token supports challenge response processing.[optional]
supportsResponseBooleanA flag indicating if the Token supports response processing.[optional]
supportsSignatureBooleanA flag indicating if the Token supports signature processing.[optional]
supportsUnlockBooleanA flag indicating if the Token supports unlock processing.[optional]
supportsUnlockTOTPBooleanA flag indicating if the Token supports unlock using TOTP processing.[optional]
typeTypeEnumThe type of token specified when the token was created or loaded into the system.[optional]
userIdStringIf the token is assigned to a user, this value specifies that user's user id.[optional]

AlgorithmTypeEnum

NameValue
AT"AT"
OATH_HOTP"OATH_HOTP"
OATH_OCRA"OATH_OCRA"
OATH_TOTP"OATH_TOTP"
VENDOR"VENDOR"

List<AllowedActionsEnum>

NameValue
ACTIVATE"ACTIVATE"
REACTIVATE"REACTIVATE"
ACTIVATE_COMPLETE"ACTIVATE_COMPLETE"
DELETE"DELETE"
UNLOCK"UNLOCK"
ENABLE"ENABLE"
DISABLE"DISABLE"
RESET"RESET"
ASSIGN"ASSIGN"
UNASSIGN"UNASSIGN"

StateEnum

NameValue
NEW"NEW"
ACTIVATING"ACTIVATING"
ACTIVE"ACTIVE"
INACTIVE"INACTIVE"
UNASSIGNED"UNASSIGNED"

TypeEnum

NameValue
ENTRUST_PHYSICAL_TOKEN"ENTRUST_PHYSICAL_TOKEN"
ENTRUST_SOFT_TOKEN"ENTRUST_SOFT_TOKEN"
GOOGLE_AUTHENTICATOR"GOOGLE_AUTHENTICATOR"
OATH_PHYSICAL_TOKEN"OATH_PHYSICAL_TOKEN"
ENTRUST_LEGACY_TOKEN"ENTRUST_LEGACY_TOKEN"