DIdigicert
accessmanagement - api keys

Rotates a specific API key.

This endpoint rotates a specific API key, allowing users to enhance security by replacing a key without changing its associated permissions or integrations.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive error handling: Returns 400 and 404 error codes with clear descriptions when requests fail.</br>- Targeted API key rotation: Leverages the apiKeyId parameter in the URL path to securely rotate a specific API key in-line with existing configurations, ensuring minimal disruption and improved credential hygiene.

post/accessmanagement/api-key/{apiKeyId}/rotate

Request

Path parameters

apiKeyIdstring required

Filters data by the API key’s unique identifier.

Request body

idstring
namestring required
notestring nullable
expireboolean required
expirationDatestring date-time nullable

Example request

{
  "id": "1234567812341233",
  "name": "Updated Name",
  "note": "Update note",
  "expire": true,
  "expirationDate": "2026-12-15T12:11:33Z"
}

Response

API key rotated successfully.

idstring
namestring
apiKeystring
expirationDatestring date-time nullable
expireboolean
notestring nullable
status'ACTIVE' | 'DISABLED' | 'EXPIRED'
lastUsedTsstring date-time
createdTsstring date-time
modifiedTsstring date-time
type'USER' | 'SERVICE'

Example response

{
  "id": "1234567812341233",
  "name": "Test Key",
  "apiKey": "usr_key_123456.bajsdb12378",
  "expirationDate": "2026-12-15T12:11:33Z",
  "expire": true,
  "note": "None",
  "status": "ACTIVE",
  "lastUsedTs": "2025-09-01T15:37:56.338859+02:00",
  "createdTs": "2025-09-01T15:37:56.338859+02:00",
  "modifiedTs": "2025-09-01T15:37:56.338909+02:00",
  "roles": [
    {
      "id": 3,
      "name": "Admin",
      "description": "Administrator role with full permissions"
    }
  ],
  "resourceGroups": [
    {
      "id": 2,
      "name": "Default",
      "description": "Default resource group",
      "isDefault": true
    }
  ],
  "userGroups": [
    {
      "id": 2,
      "name": "Default",
      "description": "Default group",
      "isDefault": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.