Create a service account

Módulo Settings

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.

Requiere la capacidad org.api_keys.manage.
Alcances de OAuth: org.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: ServiceAccountCreate

serviceAccounts.create: ServiceAccountCreate
Campo	Tipo	Obligatorio	Descripción
name	string	Sí	Service account name.Restricciones: length 1 to 300
expires_at	string (date-time) \| null	No	Expiry.
role_id	string (uuid)	Sí	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"
}

Respuesta 201: ServiceAccount

serviceAccounts.create: ServiceAccount
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the service account.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Sí	Service account name.Restricciones: length 1 to 300
owner_person_id	string (uuid)	Sí	Identifier of the owner.
expires_at	string (date-time) \| null	Sí	Expiry.
user_id	string (uuid)	Sí	Identifier of the sign-in of the service account, which never signs in interactively.
person_id	string (uuid)	Sí	Identifier of the person row of the service account, the actor in audit columns.
membership_id	string (uuid)	Sí	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"
}

Ejemplos de código

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"}'