Tokens
Token controllers
📄️ Get a token by serial number
Get the token for the specified serial number. Caller requires the TOKENS:VIEW permission.
📄️ Get a token
Get the token for the specified UUID. Caller requires the TOKENS:VIEW permission.
📄️ Modify a token
Modify the specified token. Caller requires the TOKENS:EDIT permission.
📄️ Delete a token
Delete the specified token. Caller requires the TOKENS:REMOVE permission.
📄️ Complete token activation
Complete activation of the given token. Caller requires the TOKENS:ADD permission.
📄️ Start token activation
Start activation of the given token. Caller requires the TOKENS:ADD permission.
📄️ Assign token to user
Given a hardware token, assign it to a user. Caller requires the TOKENS:EDIT permission.
📄️ Modify an assigned token
Modify an assigned token. Caller requires the TOKENS:EDIT permission.
📄️ Change token state
Change the state of a token. Caller requires the TOKENS:EDIT permission.
📄️ Reset a token
Reset a token. Caller requires the TOKENS:EDIT permission.
📄️ Unassign a token
Unassign a token from a user. Caller requires the TOKENS:EDIT permission.
📄️ Unlock a token
Unlock a token. Caller requires the TOKENS:EDIT permission.
📄️ Lists a page of assigned tokens
Returns assigned tokens for the provided search parameters. Caller requires the TOKENS:VIEW permission.The following searchByAttributes are supported: <ul><li>state: NEW, ACTIVE, ACTIVATING or INACTIVE. Allowed operator: EQUALS.</li><li>serialNumber: a String up to 100 characters. Allowed operators are: EQUALS, CONTAINS, STARTS_WITH.</li><li>type: ENTRUST_SOFT_TOKEN, GOOGLE_AUTHENTICATOR, OATH_PHYSICAL_TOKEN or ENTRUST_LEGACY_TOKEN. Allowed operator: EQUALS.</li><li>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.</li><li>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.</li><li>groupId: a String value should be a UUID of an existing group. Allowed operator: EQUALS. </li><li>label: a String up to 100 characters. Allowed operator: CONTAINS. </li></ul>The orderByAttribute supports these attribute names: serialNumber, state, loadDate or lastUsedDate.Sorting by attributes containing Null values such as lastUsedDate is not possible. Therefore, any record containing Null in the orderByAttribute will be filtered out before doing the sorting.
📄️ Lists a page of unassigned hardware tokens
Returns unassigned hardware tokens for the provided search parameters. Caller requires the TOKENS:VIEW permission.The following searchByAttributes are supported: <ul><li>serialNumber: a String up to 100 characters. Allowed operators are: EQUALS, CONTAINS, STARTS_WITH.</li><li>type: OATH_PHYSICAL_TOKEN or ENTRUST_LEGACY_TOKEN. Allowed operator: EQUALS.</li><li>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.</li><li>groupId: a String value should be a UUID of an existing group. Allowed operator: EQUALS. </li></ul>The orderByAttribute supports these attribute names: serialNumber.
📄️ Assign user to token
Given a user assign a hardware token. Caller requires the TOKENS:EDIT permission.
📄️ Create a token
Create a token of the given type for the given user. Caller requires the TOKENS:ADD permission.