DIdigicert
accessmanagement - api keys

Generates a new API key.

This endpoint generates a new API key, allowing users to securely authenticate new applications or services.</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 a 400 error code with a clear description when requests fail.</br>- Seamless API key generation: Facilitates the generation of an API key in-line with the appropriate schema, ensuring smooth and efficient organization.

post/accessmanagement/api-key

Request

Request body

namestring required
notestring nullable
expirationDatestring date-time nullable

Must be specified if 'expire' is set to true

expireboolean required
type'USER' | 'SERVICE' required

Example request

{
  "name": "Test Key",
  "note": "A Note",
  "expirationDate": "2026-12-15T12:11:33Z",
  "expire": true,
  "roles": [
    {
      "id": 3
    }
  ]
}

Response

API key generated 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.