Evaluate a source authority contract.

POST

/api/admin/field-mapping/source-authority-contracts/evaluate

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/source-authority-contracts/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sourceType": "scim", "sourceId": "workday", "fieldRef": { "path": "department" }, "authorityAction": "write" }'

Evaluates whether a source is allowed to perform a specific authority action for a field reference and returns a decision with reason codes.

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

sourceType

required

string

sourceId

required

string

fieldRef

required

object

key

additional properties

authorityAction

required

string

key

additional properties

Example

{
  "sourceType": "scim",
  "sourceId": "workday",
  "fieldRef": {
    "path": "department"
  },
  "authorityAction": "write"
}

Responses

200

Source authority evaluation response.

Media type application/json

object

result

required

object

allowed

required

boolean

reasonCodes

required

Array<string>

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "allowed": 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"
}