Update a service account
Update a service account.
Updates name and/or description of a service account. Status updates should use activate/deactivate endpoints.
Context:
- Can update name and description
- Cannot update token (use delete + create for new token)
- Cannot update status (use activate/deactivate endpoints)
Related Endpoints:
- POST /service-accounts//activate - Activate account
- POST /service-accounts//deactivate - Deactivate account
Authorizations
API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY
Example:
JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN
Example:
Path Parameters
UUID of the service account to update
Body
Response
Service account updated successfully
Response model for service account operations.
Human-readable name for this service account. Examples: 'API Documentation', 'Temporal Worker'.
255"API Documentation"
Current status of the service account. Valid values: 'active', 'inactive'. Only active accounts can authenticate.
"active"
Optional description explaining the purpose and usage of this account.
"Service account for API documentation generation"
UUID of the organization this account belongs to. NULL for system accounts.
"550e8400-e29b-41d4-a716-446655440000"