Skip to main content
POST
Deactivate a service account

Authorizations

X-API-Key
string
header
required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

Authorization
string
header
required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Path Parameters

service_account_id
string<uuid>
required

UUID of the service account to deactivate

Response

Service account deactivated successfully

Response model for service account operations.

created_at
string<date-time>
required
id
string<uuid>
required
modified_by
string
required
name
string
required

Human-readable name for this service account. Examples: 'API Documentation', 'Temporal Worker'.

Maximum string length: 255
Example:

"API Documentation"

status
string
required

Current status of the service account. Valid values: 'active', 'inactive'. Only active accounts can authenticate.

Example:

"active"

updated_at
string<date-time>
required
description
string | null

Optional description explaining the purpose and usage of this account.

Example:

"Service account for API documentation generation"

organization_id
string<uuid> | null

UUID of the organization this account belongs to. NULL for system accounts.

Example:

"550e8400-e29b-41d4-a716-446655440000"