Create a role capability
Settings module
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.
- Requires the capability org.roles.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: RoleCapabilityCreate
| Field | Type | Required | Description |
|---|---|---|---|
| role_id | string (uuid) | Yes | Identifier of the role. |
| capability_code | string | Yes | Capability verb.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| reach | "own" | "assigned" | "organization" | Yes | Own rows, assigned scopes or the whole org. |
{
"role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"capability_code": "finance.po.approve",
"reach": "own"
}Response 201: RoleCapability
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the role capability. |
| org_id | string (uuid) | null | 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. |
| role_id | string (uuid) | Yes | Identifier of the role. |
| capability_code | string | Yes | Capability verb.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| reach | "own" | "assigned" | "organization" | Yes | 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"
}Code samples
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"}'