update key information

<h3>Administrator updates the key information.</h3>

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

Path parameters

idstring text required

id of the key

Request body

namestring text required

Friendly name of a key

Example request

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

Response

key modified

idstring text required

key id

namestring text required

key name

labelstring text required

key label

usage'AUTHENTICATION' | 'SIGNING' enum

intended usage for the key (signing or authentication)

availableboolean

if the key is available

saved_to_configurationboolean

if the key is saved to configuration

possible_actionsPossibleAction[]

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

key_algorithm'RSA' | 'EC' enum required

Key type

Example response

{
  "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"
}

Changes

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