Sign in
tokens

update security server token information

<h3>Administrator updates the token information.</h3>
patch/tokens/{id}

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/{id}
  • Auth: API key in header Authorization

Path parameters

idstring text required

id of the token

Request body

namestring text required

friendly name of the token

Example request

{
  "name": "my-token-0"
}

Response

token modified

idstring text required

token id

namestring text required

token name

type'SOFTWARE' | 'HARDWARE' text required

token type

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 type

logged_inboolean required

if the token has been logged in to

availableboolean required

if the token is available

saved_to_configurationboolean required

if the token is saved to configuration

read_onlyboolean required

if the token is read-only

serial_numberstring text

serial number of the token

possible_actionsPossibleAction[]

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

Example response

{
  "id": "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
  "name": "softToken-0",
  "type": "SOFTWARE",
  "keys": [
    {
      "id": "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
      "name": "friendly name",
      "label": "key label",
      "certificates": [
        {
          "ocsp_status": "IN_USE",
          "owner_id": "FI:GOV:123",
          "active": true,
          "saved_to_configuration": true,
          "certificate_details": {
            "issuer_distinguished_name": "issuer123",
            "issuer_common_name": "domain.com",
            "subject_distinguished_name": "subject123",
            "subject_common_name": "domain.com",
            "not_before": "2018-12-15T00:00:00.001Z",
            "not_after": "2018-12-15T00:00:00.001Z",
            "serial": "123456789",
            "version": 3,
            "signature_algorithm": "sha256WithRSAEncryption",
            "signature": "30af2fdc1780...",
            "public_key_algorithm": "sha256WithRSAEncryption",
            "rsa_public_key_modulus": "c44421d601...",
            "rsa_public_key_exponent": 65537,
            "ec_public_parameters": "secp256r1(1.2.840.10045.3.1.7)",
            "ec_public_key_point": "c44421d601...",
            "hash": "1234567890ABCDEF",
            "key_usages": [
              "NON_REPUDIATION"
            ],
            "subject_alternative_names": "DNS:*.example.org"
          },
          "status": "IN_USE",
          "possible_actions": [
            "DELETE"
          ]
        }
      ],
      "certificate_signing_requests": [
        {
          "id": "0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
          "owner_id": "FI:GOV:123",
          "certificate_profile": "org.example.TestCertificateInfoProvider",
          "possible_actions": [
            "DELETE"
          ]
        }
      ],
      "usage": "AUTHENTICATION",
      "available": true,
      "saved_to_configuration": true,
      "possible_actions": [
        "DELETE"
      ],
      "key_algorithm": "RSA"
    }
  ],
  "status": "OK",
  "logged_in": true,
  "available": true,
  "saved_to_configuration": true,
  "read_only": true,
  "possible_actions": [
    "DELETE"
  ]
}

Changes

No recorded changes to this operation across all 50 revisions of this API.