Skip to main content
PATCH
Update Service Account

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials
Token URL
https://cloud-login.cdata.com/oauth/token
Scopes1
management:service-accounts:write
Write access to service account resources.

Path Parameters

id
string<uuid>
required

Service account identifier (UUID).

Body

application/json
name
string

New display name. Must be unique within the organization.

description
string

New description. Replaces the existing value.

status
enum<string>

Deactivating immediately revokes all PATs.

Available options:
active,
deactivated

Response

Returns the full service account object.

id
string<uuid>

Service account identifier.

name
string

Unique display name within the organization.

description
string | null

Optional free-text description of the service account.

status
enum<string>

Current lifecycle state of the service account.

Available options:
active,
deactivated
client_id
string<uuid>

Auto-generated. Used for OAuth 2.0 client credentials authentication.

external_id
string | null

Idempotency key supplied by the calling system.

created_at
string<date-time>

ISO 8601 UTC.

created_by
string<uuid>

User ID of the creator.

Last modified on July 27, 2026