List separation of duties rule rows
Settings module
GET/separation-of-duties-rulesseparationOfDutiesRules.list
A separation of duties rule. Orgs may tighten defaults but never remove them. Returns a cursor page of separation of duties rule rows the caller may see. The default order is `code` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of SeparationOfDutiesRule
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | Rule code, the rule a refusal names.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| enforced_on | string | Yes | What the rule is enforced on.Constraints: length 1 to 300 |
| description | string | Yes | What the rule forbids.Constraints: length 1 to 2000 |
{
"data": [
{
"code": "sod_approval_requester",
"enforced_on": "Purchase orders",
"description": "The requester of a spend document cannot approve it."
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/separation-of-duties-rules" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.separationOfDutiesRules.listAll()) {
console.log(row);
}for row in xos.separation_of_duties_rules.list_all():
print(row)xos separation-of-duties-rules list --all