POST /v1/role_rules
- Scope
policies:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”organizationstringkindstring Requiredone of
group,domain,connectionmatchRoleRuleMatch Requiredrolestring Requiredmin length 1 · max length 128
priorityinteger RequiredconditionRoleRuleCondition
Responses
Section titled “Responses”- 201 OK RoleRule
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X POST \ "https://api.ohauthcat.com/v1/role_rules" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "kind": "group", "match": { "idp_group": "Engineering", "scim_group": "dgrp_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "domain": "acme.com", "connection": "conn_01J9ZQ4M7K2X8V3N5B6C1D0E9F" }, "role": "admin", "priority": 1}'const response = await fetch("https://api.ohauthcat.com/v1/role_rules", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "kind": "group", "match": { "idp_group": "Engineering", "scim_group": "dgrp_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "domain": "acme.com", "connection": "conn_01J9ZQ4M7K2X8V3N5B6C1D0E9F" }, "role": "admin", "priority": 1 }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/role_rules", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "kind": "group", "match": { "idp_group": "Engineering", "scim_group": "dgrp_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "domain": "acme.com", "connection": "conn_01J9ZQ4M7K2X8V3N5B6C1D0E9F", }, "role": "admin", "priority": 1, },)data = response.json(){ "id": "rrule_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "object": "role_rule", "organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "kind": "group", "match": { "idp_group": "Engineering", "scim_group": "dgrp_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "domain": "acme.com", "connection": "conn_01J9ZQ4M7K2X8V3N5B6C1D0E9F" }, "role": "admin", "priority": 1, "condition": { "action": "allow", "expr": { "kind": "leaf", "attribute": "email", "operator": "equals", "values": [ "enterprise" ], "children": [ null ] } }, "created_at": "2026-01-15T09:30:00Z", "updated_at": "2026-01-15T09:30:00Z"}