DIdigicert
accessmanagement - api keys

Updates a specific API key.

This endpoint updates the details of a specific API key, enabling users to keep key names or scopes up to date without generating a new key.</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>- Reliable API key updates: Facilitates the modification of a specific API key, ensuring accurate and up-to-date information across the system.</br>- Targeted data update: Leverages the apiKeyId parameter in the URL path to update the specified API key, ensuring accurate and focused modifications.

put/accessmanagement/api-key/{apiKeyId}

Request

Path parameters

apiKeyIdstring required

Filters data by the API key’s unique identifier.

Request body

idstring
namestring
notestring nullable
status'ACTIVE' | 'DISABLED' | 'EXPIRED'
type'USER' | 'SERVICE'

Example request

{
  "id": "1234567812341233",
  "name": "Test Key",
  "note": "Updated Note",
  "status": "ACTIVE",
  "roles": [
    {
      "id": 2
    }
  ],
  "userGroups": [
    {
      "id": 1
    }
  ]
}

Response

API key updated successfully.

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

Example response

{
  "id": "7e58d63b60197ceb55a1c487989a3720",
  "name": "Test Key",
  "username": "username@user.com",
  "userId": "1234",
  "keySuffix": "EcuGg",
  "expirationDate": "2026-12-15T12:11:33Z",
  "note": "None",
  "status": "ACTIVE",
  "lastUsedTs": "2025-09-10T15:06:24.154618Z",
  "createdTs": "2025-09-10T15:06:24.154618Z",
  "modifiedTs": "2025-09-10T15:06:24.154618Z",
  "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.