Skip to content
Authrim

Create a source authority contract.

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

Creates a contract defining which source may perform authority actions for a field reference. The response returns the created contract in a result envelope.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string

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

Request Body required

Section titled “Request Body required ”
Media type application/json
object
sourceType
required
string
sourceId
required
string
fieldRef
required
object
key
additional properties
authorityActions
required
Array<string>
>= 1 items
condition
object
key
additional properties
priority
integer
key
additional properties
Example 
{
  "sourceType": "scim",
  "sourceId": "workday",
  "fieldRef": {
    "path": "department"
  },
  "authorityActions": [
    "write"
  ],
  "priority": 100
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Source authority contract mutation response.

Media type application/json
object
result
required
object
id
required
string
tenantId
required
string
sourceType
required
string
sourceId
required
string
fieldRef
required
object
key
additional properties
authorityActions
required
Array<string>
condition
object | null
priority
required
integer
lifecycleState
required
string
key
additional properties
key
additional properties
Example generated
{
  "result": {
    "id": "example",
    "tenantId": "example",
    "sourceType": "example",
    "sourceId": "example",
    "fieldRef": {
      "additionalProperty": "example"
    },
    "authorityActions": [
      "example"
    ],
    "condition": "example",
    "priority": 1,
    "lifecycleState": "example"
  }
}

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

404

Section titled “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

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