Sign in
tokens

logout from token

Changed on
<h3>Administrator logs out from token.</h3>
put/tokens/{token_id}/logout

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/tokens/{token_id}/logout
  • Auth: API key in header Authorization

Path parameters

token_idstring text required

id of the token

Response

logged out

activeboolean required

if the token is active

availableboolean required

if the token is available

idstring text required

token id

logged_inboolean required

if the token has been logged in to

namestring text required

token name

possible_actionsPossibleTokenAction[]

array containing the possible actions that can be done for this item

serial_numberstring text

serial number of the token

status'OK' | 'USER_PIN_LOCKED' | 'USER_PIN_INCORRECT' | 'USER_PIN_INVALID' | 'USER_PIN_EXPIRED' | 'USER_PIN_COUNT_LOW' | 'USER_PIN_FINAL_TRY' | 'NOT_INITIALIZED' text required

token status

Example response

{
  "active": true,
  "available": true,
  "id": "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
  "logged_in": true,
  "name": "softToken-0",
  "possible_actions": [
    "LOGIN"
  ],
  "configuration_signing_keys": [
    {
      "active": true,
      "available": true,
      "created_at": "2022-01-12T00:00:00.001Z",
      "key_hash": "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
      "token_id": "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
      "possible_actions": [
        "DELETE"
      ],
      "source_type": "INTERNAL",
      "key_algorithm": "RSA"
    }
  ],
  "status": "OK"
}

Changes

  • d8bd4dedbb91Revision changes
    • ○

      added the optional property // to the response with the status

  • 0fc7d5101ea4Revision changes
    • ●

      removed the optional property // from the response with the status

    • ○

      added the optional property // to the response with the status