Create a service account
Settings module
POST/service-accountsserviceAccounts.create
A non-human member with its own audit identity. Creates a service account. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability org.api_keys.manage.
- OAuth scopes: org.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: ServiceAccountCreate
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Service account name.Constraints: length 1 to 300 |
| expires_at | string (date-time) | null | No | Expiry. |
| role_id | string (uuid) | Yes | Identifier of the role the service account's membership holds. |
{
"name": "Ledger Export Bot",
"expires_at": "2026-10-08T14:30:00Z",
"role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: ServiceAccount
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the service account. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Yes | Service account name.Constraints: length 1 to 300 |
| owner_person_id | string (uuid) | Yes | Identifier of the owner. |
| expires_at | string (date-time) | null | Yes | Expiry. |
| user_id | string (uuid) | Yes | Identifier of the sign-in of the service account, which never signs in interactively. |
| person_id | string (uuid) | Yes | Identifier of the person row of the service account, the actor in audit columns. |
| membership_id | string (uuid) | Yes | Identifier of the membership that carries the service account's role in the org. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Ledger Export Bot",
"owner_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"expires_at": "2026-10-08T14:30:00Z",
"user_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/service-accounts" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"name":"Ledger Export Bot","expires_at":"2026-10-08T14:30:00Z","role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.serviceAccounts.create({
"name": "Ledger Export Bot",
"expires_at": "2026-10-08T14:30:00Z",
"role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.service_accounts.create({"name": "Ledger Export Bot", "expires_at": "2026-10-08T14:30:00Z", "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos service-accounts create --data '{"name":"Ledger Export Bot","expires_at":"2026-10-08T14:30:00Z","role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'