Skip to content
Authrim

Create a role assignment rule.

POST
/api/admin/role-assignment-rules
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/role-assignment-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "assign_engineering_viewer", "role_id": "role_viewer", "condition": { "type": "email_domain", "domain": "example.com" }, "actions": [ { "type": "assign_role", "role_id": "role_viewer" } ], "priority": 10 }'

Create an automatic role assignment rule based on IdP claims or user context. Rule names must be unique per tenant.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
description
string
role_id
required
string
scope_type
string
default: global
scope_target
string
condition
required
object
key
additional properties
actions
required
Array<object>
object
key
additional properties
priority
integer
is_active
boolean
stop_processing
boolean
valid_from
integer format: int64
valid_until
integer format: int64
key
additional properties
Example 
{
  "name": "assign_engineering_viewer",
  "role_id": "role_viewer",
  "condition": {
    "type": "email_domain",
    "domain": "example.com"
  },
  "actions": [
    {
      "type": "assign_role",
      "role_id": "role_viewer"
    }
  ],
  "priority": 10
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Role assignment rule response.

Media type application/json
object
id
required
string
tenant_id
required
string
name
required
string
description
string | null
role_id
required
string
scope_type
required
string
scope_target
required
string | null
condition
required
object
key
additional properties
actions
required
Array<object>
object
key
additional properties
priority
required
integer
is_active
required
boolean
stop_processing
required
boolean
valid_from
integer | null format: int64
valid_until
integer | null format: int64
created_by
string | null
created_at
required
integer format: int64
updated_at
required
integer format: int64
key
additional properties
Example 
{
  "id": "rar_123",
  "tenant_id": "tenant_123",
  "name": "assign_engineering_viewer",
  "description": "Assign viewer role to engineering users.",
  "role_id": "role_viewer",
  "scope_type": "global",
  "scope_target": "",
  "condition": {
    "type": "email_domain",
    "domain": "example.com"
  },
  "actions": [
    {
      "type": "assign_role",
      "role_id": "role_viewer"
    }
  ],
  "priority": 10,
  "is_active": true,
  "stop_processing": false,
  "created_at": 1770000000,
  "updated_at": 1770000000
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}