Lists a page of assigned tokens
POST/api/web/v1/tokenspaged/assigned
Returns assigned tokens for the provided search parameters. Caller requires the TOKENS:VIEW permission.The following searchByAttributes are supported:
- state: NEW, ACTIVE, ACTIVATING or INACTIVE. Allowed operator: EQUALS.
- serialNumber: a String up to 100 characters. Allowed operators are: EQUALS, CONTAINS, STARTS_WITH.
- type: ENTRUST_SOFT_TOKEN, GOOGLE_AUTHENTICATOR, OATH_PHYSICAL_TOKEN or ENTRUST_LEGACY_TOKEN. Allowed operator: EQUALS.
- loadDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
- lastUsedDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
- groupId: a String value should be a UUID of an existing group. Allowed operator: EQUALS.
- label: a String up to 100 characters. Allowed operator: CONTAINS.
Request
- application/json
Body
required
Array [
]
Users search only: additional, non-core attributes to include in the returned object. Attribute names are specific to the returned object.
Identifies the page to return when paging over a result set--if present, search by / order by attributes are ignored.
Possible values: >= 1
and <= 100
Identifies the maximum number of items to include in a page (1-100).
orderByAttribute
object
An attribute used to sort the result from a search.
Identifies whether to order results in ascending order.
Identifies the attribute.
searchByAttributes
object[]
Identifies attributes for searching purposes. Some end-points have pre-defined values and ignore this attribute.
Identifies the attribute we are searching for.
Possible values: [EQUALS
, NOT_EQUALS
, CONTAINS
, NOT_CONTAINS
, STARTS_WITH
, ENDS_WITH
, GREATER_THAN
, GREATER_THAN_OR_EQUAL
, LESS_THAN
, LESS_THAN_OR_EQUAL
, IN
, EXISTS
, NOT_EXISTS
]
Identifies the operator.
Identifies the value of the attribute we are searching for.
Responses
- 200
- 400
- 401
- 403
- 404
- 409
Successful
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
paging
object
Contains navigation information.
Possible values: >= 1
and <= 100
The page limit used (1-100)
The cursor pointing to the next page.
The cursor pointing to the previous page.
results
object[]
required
A single page with the list of assigned tokens found.
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.
Possible values: [ACTIVATE
, REACTIVATE
, ACTIVATE_COMPLETE
, DELETE
, UNLOCK
, ENABLE
, DISABLE
, RESET
, ASSIGN
, UNASSIGN
]
Actions that can be performed on this token.
Optional text describing this token.
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.
The unique UUID assigned to the token when it is created.
Optional label to identify an assigned token: a String up to 100 characters.
The date on which the token was last used for authentication. This value will be null if the token has never been used.
The date on which the token was created or loaded into the system.
Base-64 encoded logo. If a custom logo is provided by the customer it is returned. Otherwise a system default logo is returned.
An optional name for the token.
The mobile device platform on which an Entrust Soft Token was activated.
A flag indicating if the Entrust Soft Token has registered for transactions. Only tokens that are registered can perform token push authentication.
The serial number of the token either generated when the token was created or loaded into the system.
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.
A flag indicating if the Token supports challenge response processing.
A flag indicating if the Token supports response processing.
A flag indicating if the Token supports signature processing.
A flag indicating if the Token supports unlock processing.
A flag indicating if the Token supports unlock using TOTP processing.
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.
If the token is assigned to a user, this value specifies that user's user id.
{
"paging": {
"limit": 0,
"nextCursor": "string",
"prevCursor": "string"
},
"results": [
{
"algorithmType": "AT",
"allowedActions": [
"ACTIVATE"
],
"description": "string",
"groups": [
"string"
],
"id": "string",
"label": "PENDING",
"lastUsedDate": "2019-02-20T10:05:27Z",
"loadDate": "2019-02-19T13:15:27Z",
"logo": "string",
"name": "string",
"platform": "string",
"registeredForTransactions": true,
"serialNumber": "string",
"state": "NEW",
"supportsChallengeResponse": false,
"supportsResponse": true,
"supportsSignature": false,
"supportsUnlock": true,
"supportsUnlockTOTP": false,
"type": "ENTRUST_PHYSICAL_TOKEN",
"userId": "string"
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Access denied
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Conflict
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}