Skip to content
Authrim

Create a field mapping set.

Deprecated
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. With ownerScopeType set to platform the set is created in the platform’s namespace (the set every tenant can read), which requires platform administrator authority; any other value creates a set the calling tenant owns. A tenant set cannot carry the platform owner scope. Deprecated: this is one of the five steps (set, version, publish, compile, activate) that POST /api/admin/identity-mapping/sets and PUT /api/admin/identity-mapping/sets/{id} run in one call, with the same checks and a release safety check made when the content is saved. It keeps working unchanged; new clients use the Mapping Set facade.

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
fieldMappingKey
required
string
displayName
required
string
description
string
ownerScopeType

platform creates the set in the platform’s namespace (platform administrator authority required). Otherwise the set belongs to the calling tenant.

string
ownerScopeId
string
key
additional properties
Example 
{
  "fieldMappingKey": "workforce-to-oidc",
  "displayName": "Workforce to OIDC",
  "description": "Claims released to workforce clients."
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Field mapping set mutation response.

Media type application/json
object
result
required
object
id
required
string
tenantId
required

The tenant ID the set is stored under: the tenant’s own, or platform for a set the platform owns.

string
owner
required

Who owns the set. A platform set is shared by every tenant and read-only for them.

string
Allowed values: tenant platform
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 
{
  "result": {
    "owner": "tenant"
  }
}

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