Skip to main content

TokensApi

MethodHTTP requestDescription
assignTokenByIdUsingPUTPUT /api/web/v1/tokens/{tokenid}/assignAssign token to user
assignTokenBySerialNumberUsingPUTPUT /api/web/v1/users/{id}/tokens/assignAssign user to token
assignedTokenPageUsingPOSTPOST /api/web/v1/tokenspaged/assignedLists a page of assigned tokens
changeTokenStateUsingPUTPUT /api/web/v1/tokens/{tokenid}/changestateChange token state
completeActivateTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}/activationComplete token activation
createTokenUsingPOSTPOST /api/web/v1/users/{userid}/tokens/{type}Create a token
deleteTokenUsingDELETEDELETE /api/web/v1/tokens/{tokenid}Delete a token
getTokenBySerialNumberUsingGETGET /api/web/v1/tokens/sernum/{sernum}Get a token by serial number
getTokenUsingGETGET /api/web/v1/tokens/{tokenid}Get a token
modifyAssignedTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}/assignedModify an assigned token
modifyTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}Modify a token
resetTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}/resetReset a token
startActivateTokenUsingPOSTPOST /api/web/v1/tokens/{tokenid}/activationStart token activation
unassignTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}/unassignUnassign a token
unassignedTokenPageUsingPOSTPOST /api/web/v1/tokenspaged/unassignedLists a page of unassigned hardware tokens
unlockTokenUsingPUTPUT /api/web/v1/tokens/{tokenid}/unlockUnlock 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

NameTypeDescriptionNotes
tokenidStringThe UUID of the token to be assigned to a user.
assignParmsAssignParms

Return type

null (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

assignTokenBySerialNumberUsingPUT

assignTokenBySerialNumberUsingPUT(id, assignParms)

Assign user to token

Given a user assign a hardware token. Caller requires the TOKENS:EDIT permission.

Example

Parameters

NameTypeDescriptionNotes
idStringThe UUID of the user to which the token is to be assigned.
assignParmsAssignParms

Return type

null (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

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

NameTypeDescriptionNotes
searchParmsSearchParms

Return type

TokensPage

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

changeTokenStateUsingPUT

changeTokenStateUsingPUT(tokenid, changeStateParms)

Change token state

Change the state of a token. Caller requires the TOKENS:EDIT permission.

Example

Parameters

NameTypeDescriptionNotes
tokenidStringThe UUID of the token that will have its state changed.
changeStateParmsChangeStateParms

Return type

null (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

completeActivateTokenUsingPUT

completeActivateTokenUsingPUT(tokenid, activateCompleteParms)

Complete token activation

Complete activation of the given token. Caller requires the TOKENS:ADD permission.

Example

Parameters

NameTypeDescriptionNotes
tokenidStringThe UUID of the token for which activation is to be completed.
activateCompleteParmsActivateCompleteParms

Return type

null (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

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

NameTypeDescriptionNotes
useridStringThe UUID of the user for which a token is to be created.
typeStringThe 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]
tokenCreateParmsTokenCreateParms[optional]

Return type

Token

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

deleteTokenUsingDELETE

deleteTokenUsingDELETE(tokenid)

Delete a token

Delete the specified token. Caller requires the TOKENS:REMOVE permission.

Example

Parameters

NameTypeDescriptionNotes
tokenidStringThe UUID of the token to be deleted.

Return type

null (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

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

NameTypeDescriptionNotes
sernumStringThe serial number of the token to be retrieved.

Return type

Token

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

getTokenUsingGET

Token getTokenUsingGET(tokenid)

Get a token

Get the token for the specified UUID. Caller requires the TOKENS:VIEW permission.

Example

Parameters

NameTypeDescriptionNotes
tokenidStringThe UUID of the token to be retrieved.

Return type

Token

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

modifyAssignedTokenUsingPUT

modifyAssignedTokenUsingPUT(tokenid, assignedTokenParms)

Modify an assigned token

Modify an assigned token. Caller requires the TOKENS:EDIT permission.

Example

Parameters

NameTypeDescriptionNotes
tokenidStringThe UUID of the assigned token to be modified.
assignedTokenParmsAssignedTokenParms

Return type

null (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

modifyTokenUsingPUT

modifyTokenUsingPUT(tokenid, tokenParms)

Modify a token

Modify the specified token. Caller requires the TOKENS:EDIT permission.

Example

Parameters

NameTypeDescriptionNotes
tokenidStringThe UUID of the token to be modified.
tokenParmsTokenParms

Return type

null (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

resetTokenUsingPUT

resetTokenUsingPUT(tokenid, resetParms)

Reset a token

Reset a token. Caller requires the TOKENS:EDIT permission.

Example

Parameters

NameTypeDescriptionNotes
tokenidStringThe UUID of the token to be reset.
resetParmsResetParms

Return type

null (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

startActivateTokenUsingPOST

ActivateResult startActivateTokenUsingPOST(tokenid, activateParms)

Start token activation

Start activation of the given token. Caller requires the TOKENS:ADD permission.

Example

Parameters

NameTypeDescriptionNotes
tokenidStringThe UUID of the token to be activated.
activateParmsActivateParms[optional]

Return type

ActivateResult

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

unassignTokenUsingPUT

unassignTokenUsingPUT(tokenid)

Unassign a token

Unassign a token from a user. Caller requires the TOKENS:EDIT permission.

Example

Parameters

NameTypeDescriptionNotes
tokenidStringThe UUID of the token to be unassigned.

Return type

null (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

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

NameTypeDescriptionNotes
searchParmsSearchParms

Return type

TokensPage

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-

unlockTokenUsingPUT

UnlockResult unlockTokenUsingPUT(tokenid, unlockParms)

Unlock a token

Unlock a token. Caller requires the TOKENS:EDIT permission.

Example

Parameters

NameTypeDescriptionNotes
tokenidStringThe UUID of the token that will be unlocked.
unlockParmsUnlockParms

Return type

UnlockResult

Authorization

AdminAPIAuthentication

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful-
400Bad Request-
401Access denied-
403Forbidden-
404Not Found-
409Conflict-