Saltar al contenido

Create a role capability

Módulo Settings

POST/role-capabilitiesroleCapabilities.create

A capability granted to a role. Creates a role capability. 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.roles.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: RoleCapabilityCreate

roleCapabilities.create: RoleCapabilityCreate
CampoTipoObligatorioDescripción
role_idstring (uuid)SíIdentifier of the role.
capability_codestringSíCapability verb.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
reach"own" | "assigned" | "organization"SíOwn rows, assigned scopes or the whole org.
{
  "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "capability_code": "finance.po.approve",
  "reach": "own"
}

Respuesta 201: RoleCapability

roleCapabilities.create: RoleCapability
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the role capability.
org_idstring (uuid) | nullSíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
role_idstring (uuid)SíIdentifier of the role.
capability_codestringSíCapability verb.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
reach"own" | "assigned" | "organization"SíOwn rows, assigned scopes or the whole 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",
  "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "capability_code": "finance.po.approve",
  "reach": "own"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/role-capabilities" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","capability_code":"finance.po.approve","reach":"own"}'
const { data } = await xos.roleCapabilities.create({
    "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "capability_code": "finance.po.approve",
    "reach": "own"
  });
response = xos.role_capabilities.create({"role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "capability_code": "finance.po.approve", "reach": "own"})
xos role-capabilities create --data '{"role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","capability_code":"finance.po.approve","reach":"own"}'