roles
Settings module · 5 operations
List role rows
GET/roles
A role: a platform role or an org custom role built from the capability set. Returns a cursor page of role rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
Create a role
POST/roles
A role: a platform role or an org custom role built from the capability set. Creates a role. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
Get a role
GET/roles/{id}
A role: a platform role or an org custom role built from the capability set. Returns one role with its `ETag`. A role the caller may not see returns 404.
Update a role
PATCH/roles/{id}
A role: a platform role or an org custom role built from the capability set. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
Delete a role
DELETE/roles/{id}
A role: a platform role or an org custom role built from the capability set. Soft-deletes the role: it moves to Trash and can be restored for its table's retention period.