Evaluate a provisioning assignment rule.

POST

/api/admin/field-mapping/provisioning-assignment-rules/{ruleId}/evaluate

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/provisioning-assignment-rules/example/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "subjectId": "subject_123", "attributes": { "department": "Engineering" }, "dryRun": true }'

Evaluates the selected provisioning assignment rule for a subject or account and returns the dry-run outcome, match decision, and reason codes.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

ruleId

required

string

Header Parameters

Idempotency-Key

string

Idempotency key for state-changing operations that support replay protection.

Request Body ^required

Media type application/json

object

subjectId

string

accountId

string

dryRun

boolean

key

additional properties

Example

{
  "subjectId": "subject_123",
  "attributes": {
    "department": "Engineering"
  },
  "dryRun": true
}

Responses

200

Provisioning assignment evaluation response.

Media type application/json

object

result

required

object

matched

boolean

outcome

required

string

dryRun

required

boolean

reasonCodes

Array<string>

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "matched": true,
    "outcome": "example",
    "dryRun": true,
    "reasonCodes": [
      "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"
}

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

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