CLclaimmind
API Keys

Update Api Key

Update an API key's name, scopes, or status. Access validated based on user's role and scope.

patch/admin/api-keys/{key_id}

Request

  • Base URL
    https://developer.claimmind.life (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: token

Path parameters

key_idinteger required

Query parameters

tenant_idstring required

Tenant ID the API key belongs to

Request body

namestring nullable

New name for the key

scopesstring[] nullable

Updated scopes

statusstring nullable

Status: ENABLED or DISABLED

Response

Successful Response

idinteger required

Unique identifier for the API key

descriptionstring required

Name of the API key

key_identifierstring required

Display identifier: sk-cm-abc..xyz

scopesstring[] required

Permission scopes assigned to this key

statusstring required

Key status: ENABLED or DISABLED

organization_idstring required

Organization this key belongs to

is_org_keyboolean required

True if organization-level key

created_atstring date-time required

When the key was created

updated_atstring date-time nullable

When the key was last updated

Changes

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