API Docs / Operations / API Keys / Update an API key's name and scope

Update an API key's name and scope

PUT /account/keys/{key}

Updates an API key's name and tenant/role scope (full replacement — omit the scope fields to make the key unscoped). Use the Key (Guid) as the identifier; the key value itself never changes. Not available to API key callers.

Parameters

NameTypeDescription
key* path string (uuid)

Request Body*

{
  "name": "string",
  "tenantCode": "string",
  "systemRoleType": "Admin",
  "roleCode": "string"
}

Responses

200 OK
400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden
404 Not Found