Create a mapping template.

POST

/api/admin/field-mapping/templates

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "templateKey": "oidc-basic-profile", "displayName": "OIDC basic profile", "template": { "rules": [ { "ruleKey": "email" } ] } }'

Creates a reusable field-mapping template from a template key, display name, optional scope, and template payload.

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

templateKey

required

string

templateScope

string

displayName

required

string

template

required

object

key

additional properties

key

additional properties

Example

{
  "templateKey": "oidc-basic-profile",
  "displayName": "OIDC basic profile",
  "template": {
    "rules": [
      {
        "ruleKey": "email"
      }
    ]
  }
}

Responses

200

Mapping template mutation response.

Media type application/json

object

result

required

object

id

required

string

tenantId

required

string

templateKey

required

string

templateScope

required

string

displayName

required

string

template

required

object

key

additional properties

lifecycleState

required

string

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "id": "example",
    "tenantId": "example",
    "templateKey": "example",
    "templateScope": "example",
    "displayName": "example",
    "template": {
      "additionalProperty": "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"
}