TokensApi
Method | HTTP request | Description |
---|---|---|
assignTokenByIdUsingPUT | PUT /api/web/v1/tokens/{tokenid}/assign | Assign token to user |
assignTokenBySerialNumberUsingPUT | PUT /api/web/v1/users/{id}/tokens/assign | Assign user to token |
assignedTokenPageUsingPOST | POST /api/web/v1/tokenspaged/assigned | Lists a page of assigned tokens |
changeTokenStateUsingPUT | PUT /api/web/v1/tokens/{tokenid}/changestate | Change token state |
completeActivateTokenUsingPUT | PUT /api/web/v1/tokens/{tokenid}/activation | Complete token activation |
createTokenUsingPOST | POST /api/web/v1/users/{userid}/tokens/{type} | Create a token |
deleteTokenUsingDELETE | DELETE /api/web/v1/tokens/{tokenid} | Delete a token |
getTokenBySerialNumberUsingGET | GET /api/web/v1/tokens/sernum/{sernum} | Get a token by serial number |
getTokenUsingGET | GET /api/web/v1/tokens/{tokenid} | Get a token |
modifyAssignedTokenUsingPUT | PUT /api/web/v1/tokens/{tokenid}/assigned | Modify an assigned token |
modifyTokenUsingPUT | PUT /api/web/v1/tokens/{tokenid} | Modify a token |
resetTokenUsingPUT | PUT /api/web/v1/tokens/{tokenid}/reset | Reset a token |
startActivateTokenUsingPOST | POST /api/web/v1/tokens/{tokenid}/activation | Start token activation |
unassignTokenUsingPUT | PUT /api/web/v1/tokens/{tokenid}/unassign | Unassign a token |
unassignedTokenPageUsingPOST | POST /api/web/v1/tokenspaged/unassigned | Lists a page of unassigned hardware tokens |
unlockTokenUsingPUT | PUT /api/web/v1/tokens/{tokenid}/unlock | Unlock a token |
assignTokenByIdUsingPUT
assignTokenByIdUsingPUT(tokenid, assignParms)
Assign token to user
Given a hardware token, assign it to a user. Caller requires the TOKENS:EDIT permission.
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tokenid | String | The UUID of the token to be assigned to a user. | |
assignParms | AssignParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
assignTokenBySerialNumberUsingPUT
assignTokenBySerialNumberUsingPUT(id, assignParms)
Assign user to token
Given a user assign a hardware token. Caller requires the TOKENS:EDIT permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | String | The UUID of the user to which the token is to be assigned. | |
assignParms | AssignParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
assignedTokenPageUsingPOST
TokensPage assignedTokenPageUsingPOST(searchParms)
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:
- 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.
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.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
searchParms | SearchParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
changeTokenStateUsingPUT
changeTokenStateUsingPUT(tokenid, changeStateParms)
Change token state
Change the state of a token. Caller requires the TOKENS:EDIT permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tokenid | String | The UUID of the token that will have its state changed. | |
changeStateParms | ChangeStateParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
completeActivateTokenUsingPUT
completeActivateTokenUsingPUT(tokenid, activateCompleteParms)
Complete token activation
Complete activation of the given token. Caller requires the TOKENS:ADD permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tokenid | String | The UUID of the token for which activation is to be completed. | |
activateCompleteParms | ActivateCompleteParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
createTokenUsingPOST
Token createTokenUsingPOST(userid, type, tokenCreateParms)
Create a token
Create a token of the given type for the given user. Caller requires the TOKENS:ADD permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
userid | String | The UUID of the user for which a token is to be created. | |
type | String | The type of the token to be created. Only soft tokens can be created so this value must be one of ENTRUST_SOFT_TOKEN or GOOGLE_AUTHENTICATOR. | [enum: ENTRUST_PHYSICAL_TOKEN, ENTRUST_SOFT_TOKEN, GOOGLE_AUTHENTICATOR, OATH_PHYSICAL_TOKEN, ENTRUST_LEGACY_TOKEN] |
tokenCreateParms | TokenCreateParms | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
deleteTokenUsingDELETE
deleteTokenUsingDELETE(tokenid)
Delete a token
Delete the specified token. Caller requires the TOKENS:REMOVE permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tokenid | String | The UUID of the token to be deleted. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
getTokenBySerialNumberUsingGET
Token getTokenBySerialNumberUsingGET(sernum)
Get a token by serial number
Get the token for the specified serial number. Caller requires the TOKENS:VIEW permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
sernum | String | The serial number of the token to be retrieved. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
getTokenUsingGET
Token getTokenUsingGET(tokenid)
Get a token
Get the token for the specified UUID. Caller requires the TOKENS:VIEW permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tokenid | String | The UUID of the token to be retrieved. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
modifyAssignedTokenUsingPUT
modifyAssignedTokenUsingPUT(tokenid, assignedTokenParms)
Modify an assigned token
Modify an assigned token. Caller requires the TOKENS:EDIT permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tokenid | String | The UUID of the assigned token to be modified. | |
assignedTokenParms | AssignedTokenParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
modifyTokenUsingPUT
modifyTokenUsingPUT(tokenid, tokenParms)
Modify a token
Modify the specified token. Caller requires the TOKENS:EDIT permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tokenid | String | The UUID of the token to be modified. | |
tokenParms | TokenParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
resetTokenUsingPUT
resetTokenUsingPUT(tokenid, resetParms)
Reset a token
Reset a token. Caller requires the TOKENS:EDIT permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tokenid | String | The UUID of the token to be reset. | |
resetParms | ResetParms |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
startActivateTokenUsingPOST
ActivateResult startActivateTokenUsingPOST(tokenid, activateParms)
Start token activation
Start activation of the given token. Caller requires the TOKENS:ADD permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tokenid | String | The UUID of the token to be activated. | |
activateParms | ActivateParms | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
unassignTokenUsingPUT
unassignTokenUsingPUT(tokenid)
Unassign a token
Unassign a token from a user. Caller requires the TOKENS:EDIT permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tokenid | String | The UUID of the token to be unassigned. |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
unassignedTokenPageUsingPOST
TokensPage unassignedTokenPageUsingPOST(searchParms)
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:
- serialNumber: a String up to 100 characters. Allowed operators are: EQUALS, CONTAINS, STARTS_WITH.
- type: 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.
- groupId: a String value should be a UUID of an existing group. Allowed operator: EQUALS.
The orderByAttribute supports these attribute names: serialNumber.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
searchParms | SearchParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |
unlockTokenUsingPUT
UnlockResult unlockTokenUsingPUT(tokenid, unlockParms)
Unlock a token
Unlock a token. Caller requires the TOKENS:EDIT permission.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
tokenid | String | The UUID of the token that will be unlocked. | |
unlockParms | UnlockParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | Successful | - |
400 | Bad Request | - |
401 | Access denied | - |
403 | Forbidden | - |
404 | Not Found | - |
409 | Conflict | - |