TokensApi
| Method | HTTP request | Description |
|---|---|---|
| assign_token_by_id_using_put | PUT /api/web/v1/tokens/{tokenid}/assign | Assign token to user |
| assign_token_by_serial_number_using_put | PUT /api/web/v1/users/{id}/tokens/assign | Assign user to token |
| assigned_token_page_using_post | POST /api/web/v1/tokenspaged/assigned | Lists a page of assigned tokens |
| change_token_state_using_put | PUT /api/web/v1/tokens/{tokenid}/changestate | Change token state |
| complete_activate_token_using_put | PUT /api/web/v1/tokens/{tokenid}/activation | Complete token activation |
| create_token_using_post | POST /api/web/v1/users/{userid}/tokens/{type} | Create a token |
| delete_token_using_delete | DELETE /api/web/v1/tokens/{tokenid} | Delete a token |
| get_token_by_serial_number_using_get | GET /api/web/v1/tokens/sernum/{sernum} | Get a token by serial number |
| get_token_using_get | GET /api/web/v1/tokens/{tokenid} | Get a token |
| modify_assigned_token_using_put | PUT /api/web/v1/tokens/{tokenid}/assigned | Modify an assigned token |
| modify_token_using_put | PUT /api/web/v1/tokens/{tokenid} | Modify a token |
| reset_token_using_put | PUT /api/web/v1/tokens/{tokenid}/reset | Reset a token |
| start_activate_token_using_post | POST /api/web/v1/tokens/{tokenid}/activation | Start token activation |
| unassign_token_using_put | PUT /api/web/v1/tokens/{tokenid}/unassign | Unassign a token |
| unassigned_token_page_using_post | POST /api/web/v1/tokenspaged/unassigned | Lists a page of unassigned hardware tokens |
| unlock_token_using_put | PUT /api/web/v1/tokens/{tokenid}/unlock | Unlock a token |
assign_token_by_id_using_put
assign_token_by_id_using_put(tokenid, assign_parms)
Assign token to user
Given a hardware token, assign it to a user. Caller requires the TOKENS:EDIT permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | str | The UUID of the token to be assigned to a user. | |
| assign_parms | 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 | - |
assign_token_by_serial_number_using_put
assign_token_by_serial_number_using_put(id, assign_parms)
Assign user to token
Given a user assign a hardware token. Caller requires the TOKENS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the user to which the token is to be assigned. | |
| assign_parms | 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 | - |
assigned_token_page_using_post
TokensPage assigned_token_page_using_post(search_parms)
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
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| search_parms | 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 | - |
change_token_state_using_put
change_token_state_using_put(tokenid, change_state_parms)
Change token state
Change the state of a token. Caller requires the TOKENS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | str | The UUID of the token that will have its state changed. | |
| change_state_parms | 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 | - |
complete_activate_token_using_put
complete_activate_token_using_put(tokenid, activate_complete_parms)
Complete token activation
Complete activation of the given token. Caller requires the TOKENS:ADD permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | str | The UUID of the token for which activation is to be completed. | |
| activate_complete_parms | 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 | - |
create_token_using_post
Token create_token_using_post(userid, type, token_create_parms=token_create_parms)
Create a token
Create a token of the given type for the given user. Caller requires the TOKENS:ADD permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | str | The UUID of the user for which a token is to be created. | |
| type | str | 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. | |
| token_create_parms | 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 | - |
delete_token_using_delete
delete_token_using_delete(tokenid)
Delete a token
Delete the specified token. Caller requires the TOKENS:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | str | 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 | - |
get_token_by_serial_number_using_get
Token get_token_by_serial_number_using_get(sernum)
Get a token by serial number
Get the token for the specified serial number. Caller requires the TOKENS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| sernum | str | 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 | - |
get_token_using_get
Token get_token_using_get(tokenid)
Get a token
Get the token for the specified UUID. Caller requires the TOKENS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | str | 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 | - |
modify_assigned_token_using_put
modify_assigned_token_using_put(tokenid, assigned_token_parms)
Modify an assigned token
Modify an assigned token. Caller requires the TOKENS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | str | The UUID of the assigned token to be modified. | |
| assigned_token_parms | 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 | - |
modify_token_using_put
modify_token_using_put(tokenid, token_parms)
Modify a token
Modify the specified token. Caller requires the TOKENS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | str | The UUID of the token to be modified. | |
| token_parms | 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 | - |
reset_token_using_put
reset_token_using_put(tokenid, reset_parms)
Reset a token
Reset a token. Caller requires the TOKENS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | str | The UUID of the token to be reset. | |
| reset_parms | 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 | - |
start_activate_token_using_post
ActivateResult start_activate_token_using_post(tokenid, activate_parms=activate_parms)
Start token activation
Start activation of the given token. Caller requires the TOKENS:ADD permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | str | The UUID of the token to be activated. | |
| activate_parms | 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 | - |
unassign_token_using_put
unassign_token_using_put(tokenid)
Unassign a token
Unassign a token from a user. Caller requires the TOKENS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | str | 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 | - |
unassigned_token_page_using_post
TokensPage unassigned_token_page_using_post(search_parms)
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
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| search_parms | 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 | - |
unlock_token_using_put
UnlockResult unlock_token_using_put(tokenid, unlock_parms)
Unlock a token
Unlock a token. Caller requires the TOKENS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tokenid | str | The UUID of the token that will be unlocked. | |
| unlock_parms | 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 | - |