Skip to content
Authrim

Create a field mapping version.

POST
/api/admin/field-mapping/field-mapping-sets/{fieldMappingSetId}/versions
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/field-mapping-sets/example/versions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "versionLabel": "v1", "rules": [ { "ruleKey": "map-department", "ruleKind": "direct", "action": "map", "priority": 100, "edges": [ { "sourceRef": { "path": "department" }, "targetRef": { "claim": "department" } } ] } ] }'

Creates a draft version for a field mapping set with rules, edges, transforms, validation rules, release rules, and conflict rules. Mapping edges cannot target claims owned by an OIDC or introspection protocol envelope. Every source field marked mappingRequired in a referenced Source Profile must be connected by an edge.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
fieldMappingSetId
required
string

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
versionLabel
required
string
compatibilityRange
string
authorId
string
sourceProfileIds

Source Profile references validated for mappingRequired fields, including profiles with no connected edges yet.

Array<string>
rules
required
Array<object>
object
key
additional properties
key
additional properties
Example 
{
  "versionLabel": "v1",
  "rules": [
    {
      "ruleKey": "map-department",
      "ruleKind": "direct",
      "action": "map",
      "priority": 100,
      "edges": [
        {
          "sourceRef": {
            "path": "department"
          },
          "targetRef": {
            "claim": "department"
          }
        }
      ]
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Field mapping version mutation response.

Media type application/json
object
result
required
object
id
required
string
tenantId
required
string
fieldMappingSetId
required
string
versionLabel
required
string
lifecycleState
required
string
fieldMappingHash
required
string
compatibilityRange
string | null
authorId
string | null
publishedAt
integer | null
createdAt
integer
updatedAt
integer
directions
object
source
boolean
destination
boolean
key
additional properties
sourceProfileIds
Array<string>
destinationProfileIds
Array<string>
rules
Array<object>
object
key
additional properties
latestSnapshot
object | null
key
additional properties
key
additional properties
Example generated
{
  "result": {
    "id": "example",
    "tenantId": "example",
    "fieldMappingSetId": "example",
    "versionLabel": "example",
    "lifecycleState": "example",
    "fieldMappingHash": "example",
    "compatibilityRange": "example",
    "authorId": "example",
    "publishedAt": 1,
    "createdAt": 1,
    "updatedAt": 1,
    "directions": {
      "source": true,
      "destination": true
    },
    "sourceProfileIds": [
      "example"
    ],
    "destinationProfileIds": [
      "example"
    ],
    "rules": [
      {
        "additionalProperty": "example"
      }
    ],
    "latestSnapshot": "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"
}