Create a field mapping set.

POST

/api/admin/field-mapping/field-mapping-sets

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/field-mapping-sets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "fieldMappingKey": "workforce-to-oidc", "displayName": "Workforce to OIDC", "description": "Claims released to workforce clients." }'

Creates a field mapping set container. Versions and rules are added through the versions endpoint.

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

fieldMappingKey

required

string

displayName

required

string

description

string

ownerScopeType

string

ownerScopeId

string

key

additional properties

Example

{
  "fieldMappingKey": "workforce-to-oidc",
  "displayName": "Workforce to OIDC",
  "description": "Claims released to workforce clients."
}

Responses

200

Field mapping set mutation response.

Media type application/json

object

result

required

object

id

required

string

tenantId

required

string

fieldMappingKey

required

string

displayName

required

string

description

string | null

lifecycleState

required

string

createdAt

required

Unix epoch milliseconds when the field mapping set was created.

integer format: int64

updatedAt

required

Unix epoch milliseconds when the field mapping set was last updated.

integer format: int64

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "id": "example",
    "tenantId": "example",
    "fieldMappingKey": "example",
    "displayName": "example",
    "description": "example",
    "lifecycleState": "example",
    "createdAt": 1,
    "updatedAt": 1
  }
}

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