Create a field-mapping attribute field.

POST

/api/admin/field-mapping/attribute-fields

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/attribute-fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "protocol": "oidc", "fieldKey": "department", "displayName": "Department", "valueType": "string", "classification": "internal", "surfaces": [ "id_token", "userinfo" ] }'

Creates an attribute field registry entry. Platform owner scope is allowed only for platform-admin authority.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

ownerScopeType

string

Allowed values: platform tenant

ownerScopeId

string | null

protocol

required

string

Allowed values: oidc saml vc

fieldKey

required

string

displayName

required

string

valueType

string

default: string

classification

string

default: internal

surfaces

Array<string>

key

additional properties

Example

{
  "protocol": "oidc",
  "fieldKey": "department",
  "displayName": "Department",
  "valueType": "string",
  "classification": "internal",
  "surfaces": [
    "id_token",
    "userinfo"
  ]
}

Responses

200

Field mapping attribute field creation response.

Media type application/json

object

result

required

object

id

required

string

tenantId

required

string

ownerScopeType

required

string

Allowed values: platform tenant

ownerScopeId

string | null

protocol

required

string

Allowed values: oidc saml vc

fieldKey

required

string

displayName

required

string

valueType

required

string

classification

required

string

surfaces

required

Array<string>

lifecycleState

required

string

key

additional properties

key

additional properties

Example

{
  "result": {
    "ownerScopeType": "platform",
    "protocol": "oidc"
  }
}

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