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
void AssignTokenByIdUsingPUT (string tokenid, AssignParms assignParms)
Assign token to user
Given a hardware token, assign it to a user. Caller requires the TOKENS:EDIT permission.
Using the AssignTokenByIdUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | string | The UUID of the token to be assigned to a user. | |
| assignParms | AssignParms |
Return type
void (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
void AssignTokenBySerialNumberUsingPUT (string id, AssignParms assignParms)
Assign user to token
Given a user assign a hardware token. Caller requires the TOKENS:EDIT permission.
Example
Using the AssignTokenBySerialNumberUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the user to which the token is to be assigned. | |
| assignParms | AssignParms |
Return type
void (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 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
Using the AssignedTokenPageUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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
void ChangeTokenStateUsingPUT (string tokenid, ChangeStateParms changeStateParms)
Change token state
Change the state of a token. Caller requires the TOKENS:EDIT permission.
Example
Using the ChangeTokenStateUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | string | The UUID of the token that will have its state changed. | |
| changeStateParms | ChangeStateParms |
Return type
void (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
void CompleteActivateTokenUsingPUT (string tokenid, ActivateCompleteParms activateCompleteParms)
Complete token activation
Complete activation of the given token. Caller requires the TOKENS:ADD permission.
Example
Using the CompleteActivateTokenUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | string | The UUID of the token for which activation is to be completed. | |
| activateCompleteParms | ActivateCompleteParms |
Return type
void (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 (string userid, string type, TokenCreateParms tokenCreateParms = null)
Create a token
Create a token of the given type for the given user. Caller requires the TOKENS:ADD permission.
Example
Using the CreateTokenUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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. | |
| 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
void DeleteTokenUsingDELETE (string tokenid)
Delete a token
Delete the specified token. Caller requires the TOKENS:REMOVE permission.
Example
Using the DeleteTokenUsingDELETEWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | string | The UUID of the token to be deleted. |
Return type
void (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 (string sernum)
Get a token by serial number
Get the token for the specified serial number. Caller requires the TOKENS:VIEW permission.
Example
Using the GetTokenBySerialNumberUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 (string tokenid)
Get a token
Get the token for the specified UUID. Caller requires the TOKENS:VIEW permission.
Example
Using the GetTokenUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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
void ModifyAssignedTokenUsingPUT (string tokenid, AssignedTokenParms assignedTokenParms)
Modify an assigned token
Modify an assigned token. Caller requires the TOKENS:EDIT permission.
Example
Using the ModifyAssignedTokenUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | string | The UUID of the assigned token to be modified. | |
| assignedTokenParms | AssignedTokenParms |
Return type
void (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
void ModifyTokenUsingPUT (string tokenid, TokenParms tokenParms)
Modify a token
Modify the specified token. Caller requires the TOKENS:EDIT permission.
Example
Using the ModifyTokenUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | string | The UUID of the token to be modified. | |
| tokenParms | TokenParms |
Return type
void (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
void ResetTokenUsingPUT (string tokenid, ResetParms resetParms)
Reset a token
Reset a token. Caller requires the TOKENS:EDIT permission.
Example
Using the ResetTokenUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | string | The UUID of the token to be reset. | |
| resetParms | ResetParms |
Return type
void (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 (string tokenid, ActivateParms activateParms = null)
Start token activation
Start activation of the given token. Caller requires the TOKENS:ADD permission.
Example
Using the StartActivateTokenUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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
void UnassignTokenUsingPUT (string tokenid)
Unassign a token
Unassign a token from a user. Caller requires the TOKENS:EDIT permission.
Example
Using the UnassignTokenUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | string | The UUID of the token to be unassigned. |
Return type
void (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 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
Using the UnassignedTokenPageUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 (string tokenid, UnlockParms unlockParms)
Unlock a token
Unlock a token. Caller requires the TOKENS:EDIT permission.
Example
Using the UnlockTokenUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 | - |