Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

api-key-controller

Update API key Description

Updates the description of the existing API key by apiKeyId. Only the description can be updated. Referencing a non-existing ApiKey Id will cause a 'Not Found' error.

Available for any authorized user.

put/api/apiKey/{id}/description

Path parameters

idstring uuid required

A string value representing the api key id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

Request body

string required

New description for the API key

Response

OK

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

expirationTimeinteger

Expiration time of the API key.

descriptionstring required

API Key description.

enabledboolean

Enabled/disabled API key.

expiredboolean

Indicates if the API key is expired based on current time. Returns false if expirationTime is 0 (no expiry).

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "API_KEY"
  },
  "createdTime": 1746028547220,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "userId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "USER"
  },
  "description": "API Key description",
  "enabled": true
}