Test role assignment rule

POST

/api/admin/role-assignment-rules/{id}/test

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/role-assignment-rules/example/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "context": { "email": "[email protected]", "email_verified": true, "provider_id": "google", "idp_claims": { "hd": "example.com" }, "user_type": "employee" } }'

Evaluates one stored role assignment rule against a supplied user or IdP context without persisting changes.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

context

required

object

email

string

email_verified

boolean

provider_id

string

idp_claims

object

key

additional properties

user_type

string

key

additional properties

key

additional properties

Example

{
  "context": {
    "email": "[email protected]",
    "email_verified": true,
    "provider_id": "google",
    "idp_claims": {
      "hd": "example.com"
    },
    "user_type": "employee"
  }
}

Responses

200

Role assignment rule test response.

Media type application/json

object

matched

boolean

reason

string

actions

Array<object>

object

key

additional properties

key

additional properties

Example ^generated

{
  "matched": true,
  "reason": "example",
  "actions": [
    {
      "additionalProperty": "example"
    }
  ]
}

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

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

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"
}

404

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

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"
}