Create a provisioning assignment rule.

POST

/api/admin/field-mapping/provisioning-assignment-rules

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/provisioning-assignment-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ruleType": "group_membership", "targetType": "group", "targetId": "group_engineering", "condition": { "equals": { "path": "department", "value": "Engineering" } } }'

Creates a tenant-scoped provisioning assignment rule with target, condition, priority, and lifecycle state. The response is wrapped as { result }.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Header Parameters

Idempotency-Key

string

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

Request Body ^required

Media type application/json

object

scopeType

string

scopeId

string | null

ruleType

required

string

targetType

required

string

targetId

required

string

condition

required

object

key

additional properties

priority

integer

lifecycleState

string

Allowed values: draft active retired

key

additional properties

Example

{
  "ruleType": "group_membership",
  "targetType": "group",
  "targetId": "group_engineering",
  "condition": {
    "equals": {
      "path": "department",
      "value": "Engineering"
    }
  }
}

Responses

200

Provisioning assignment rule create response.

Media type application/json

object

result

required

object

id

required

string

tenantId

required

string

targetType

required

string

targetId

required

string

lifecycleState

required

string

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "id": "example",
    "tenantId": "example",
    "targetType": "example",
    "targetId": "example",
    "lifecycleState": "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"
}