GetData: Token types
This page documents the data types available in GetData for tokens, token manufacturers, token articles, token profiles, and token templates.
\{internal.token.&&}
- \{internal.token.&&}
-
This will return attributes and types from a token in the system.
- \{internal.token.id}
-
Returns the id of the token.
- \{internal.token.organizationid}
-
Returns the organization id of the token.
- \{internal.token.referenceid}
-
Returns the reference id. This reference is the main id of the token if current token is revoked and flagged as a history token.
- \{internal.token.profileid}
-
Returns the id of the token profile.
- \{internal.token.templateid}
-
Returns the id of the token template if available.
- \{internal.token.typeid}
-
Returns the id of the token type.
- \{internal.token.type}
-
Returns the name of the token type. Available types: Undefined, SmartCard, KeyToken, VirtualToken, MobileToken, FileToken and NonToken.
- \{internal.token.subtypeid}
-
Returns the id of the subordinated token type.
- \{internal.token.subtype}
-
Returns the name of the subordinated token type. Available type: SoftToken (used if type is VirtualToken), TPM (used if type is VirtualToken) and PKCS12 (used of type is FileToken).
- \{internal.token.name}
-
Returns the friendly name of a token, if available.
- \{internal.token.serialnumber}
-
Returns the serial number of the token.
- \{internal.token.sequencenumber1}
-
Returns the primary sequence number of the token if available.
- \{internal.token.sequencenumber2}
-
Returns the secondary sequence number of the token if available.
- \{internal.token.contactless}
-
Returns the current contactless value of the token if available.
- \{internal.token.validfrom}
-
Returns date and time when the token was created in the system.
- \{internal.token.validto}
-
Returns date and time when the token expires if available.
- \{internal.token.status}
-
Returns the id of the status if the token.
- \{internal.token.statusadditional}
-
Returns the id of the additional status of the token if available.
- \{internal.token.historydatetime}
-
Returns date and time when the token was revoked.
- \{internal.token.historytype}
-
Returns the latest name of the token template when token was revoked.
- \{internal.token.hasissuedcertificate}
-
Returns condition (true/false) if the token has any issued certificate(s).
- \{internal.token.hasissuedpasskey}
-
Returns condition (true/false) if the token has any issued passkey(s).
- \{internal.token.hasvalidcertificate}
-
Returns condition (true/false) if the token has any valid issued certificate(s).
- \{internal.token.hasuserrelation}
-
Returns condition (true/false) if the token has any related user.
- \{internal.token.userid}
-
Returns the id of related user if exists.
- \{internal.token.profilename}
-
Returns the name of the related token profile.
- \{internal.token.profilelabel}
-
Returns the label of the related token profile.
- \{internal.token.profilemodel}
-
Returns the model of the related token profle.
- \{internal.token.extrainfo}
-
Returns extra customized information of the token if available.
- \{internal.token.idledatetime}
-
Returns date and time when the token was last used if available.
- \{internal.token.additionalinfo}
-
Returns additional information of the token if available.
\{internal.tokenmanufacturer.%%}
- \{internal.tokenmanufacturer.%%}
-
This will return attributes and types from a token manufacturer in the system. An identifier of the manufacturer is required for loading these data.
- \{internal.tokenmanufacturer.id}
-
Returns the unique id of the token manufacturer.
- \{internal.tokenmanufacturer.referenceid}
-
Returns the reference id of the main order manufacturer.
- \{internal.tokenmanufacturer.organizationid}
-
Returns the organization id of the token manufacturer.
- \{internal.tokenmanufacturer.name}
-
Returns the name of the manufacturer (only Thales is supported).
- \{internal.tokenmanufacturer.type}
-
Returns the service type of the item. Available types: Order, Revoke and Status.
- \{internal.tokenmanufacturer.server}
-
Returns the server or URL against the service of the manufacturer.
- \{internal.tokenmanufacturer.customerreference}
-
Returns the reference of the customer against the manufactuer.
- \{internal.tokenmanufacturer.authenticationtype}
-
Returns the type of authentication against the service. Available types: Password and Certificate.
- \{internal.tokenmanufacturer.authenticationcerthash}
-
Returns the thumbprint (hash/digest) of the authentication certificate if available.
- \{internal.tokenmanufacturer.signaturecerthash}
-
Returns the thumbprint (hash/digest) of the signature certificate if available.
- \{internal.tokenmanufacturer.additionalinfo}
-
Returns additional information of the token manufacturer if available.
\{internal.tokenmanufacturerarticle.%%}
- \{internal.tokenmanufacturerarticle.%%}
-
This will return attributes and types from articles of token manufacturers in the system. An identifier of the article is required for loading these data.
- \{internal.tokenmanufacturerarticle.id}
-
Returns the unique id of the token manufacture article.
- \{internal.tokenmanufacturerarticle.organizationid}
-
Returns the organization id of the manufacturer article.
- \{internal.tokenmanufacturerarticle.manufacturerid}
-
Returns the id of the manufacturer.
- \{internal.tokenmanufacturerarticle.profileid}
-
Returns the id of the token profile if article type is defined as a token.
- \{internal.tokenmanufacturerarticle.name}
-
Returns the name of the article.
- \{internal.tokenmanufacturerarticle.description}
-
Returns the description of the article if available.
- \{internal.tokenmanufacturerarticle.type}
-
Returns the name of the generic article type. Available types: Token, Reader, Accessories and Other.
- \{internal.tokenmanufacturerarticle.tokentype}
-
Returns the type name of token articles. Available types: PersonalizedToken, PersonalizedTokenCodeLetter and NonPersonalizedToken.
- \{internal.tokenmanufacturerarticle.isenabled}
-
Returns true/false if the certificate is enabled or not.
- \{nternal.tokenmanufacturerarticle.additionalinfo}
-
Returns additional information of the article if available.
\{internal.tokenprofile.%%}
- \{internal.tokenprofile.%%}
-
This will return attributes and types from profile configuration of a token. An identifier of the profile is required for loading these data.
- \{internal.tokenprofile.id}
-
Returns the unique id of the token profile.
- \{internal.tokenprofile.organizationid}
-
Returns the organization id of the token profile.
- \{internal.tokenprofile.atr}
-
Returns the ATR of the token profile, used for matching of local tokens.
- \{internal.tokenprofile.label}
-
Returns the label of the token profile, used for matching of local tokens.
- \{internal.tokenprofile.model}
-
Returns the model of the token profile, used for matching of local tokens.
- \{internal.tokenprofile.name}
-
Returns the friendly name of the token profile.
- \{internal.tokenprofile.isenabled}
-
Returns true/false if the token profile is enabled.
- \{internal.tokenprofile.additionalinfo}
-
Returns additional information of the token profile if available.
\{internal.tokentemplate.%%}
- \{internal.tokentemplate.%%}
-
This will return attributes and types from template configuration of a token. An identifier of the template is required for loading these data.
- \{internal.tokentemplate.id}
-
Returns the unique id of the token template.
- \{internal.tokentemplate.organizationid}
-
Returns the organization id of the token template.
- \{internal.tokentemplate.manufacturerarticleid}
-
Returns the reference id of manufacturer article if available.
- \{internal.tokentemplate.name}
-
Returns the name of template.
- \{internal.tokentemplate.description}
-
Returns the description of the template if available.
- \{internal.tokentemplate.validitymin}
-
Returns the minimum validity of the token template (key + value) as date time (ISO 8601) if available.
- \{internal.tokentemplate.validityminkey}
-
Returns the key id of minimum validity.
- \{internal.tokentemplate.validityminvalue}
-
Returns the value of minimum validity.
- \{internal.tokentemplate.validitydefault}
-
Returns the default validity of the token template (key + value) as date time (ISO 8601) if available.
- \{internal.tokentemplate.validitydefaultkey}
-
Returns the key id of default validity.
- \{internal.tokentemplate.validitydefaultvalue}
-
Returns the value of default validity.
- \{internal.tokentemplate.validitymax}
-
Returns the maximum validity of the token template (key + value) as date time (ISO 8601) if available.
- \{internal.tokentemplate.validitymaxkey}
-
Returns the key id of maximum validity.
- \{internal.tokentemplate.validitymaxvalue}
-
Returns the value of maximum validity.
- \{internal.tokentemplate.isvisible}
-
Returns true/false if the token template should be visible in generic lists.
- \{internal.tokentemplate.usageid}
-
Returns the id of usage of the token template.
- \{internal.tokentemplate.usage}
-
Returns the name of usage of the token template. Available types: Standard and Limited.
- \{internal.tokentemplate.additionalinfo}
-
Returns additional information of the token template if available.