Create a field catalog.

POST

/api/admin/field-mapping/catalogs

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/catalogs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "catalogKey": "workforce", "displayName": "Workforce catalog", "versionLabel": "v1", "entries": [ { "id": "department", "namespace": "profile", "path": "department", "valueType": "string", "cardinality": "single", "classification": "internal" } ] }'

Creates a field catalog and initial catalog version from catalog entries and optional custom entries. The mutation is idempotency-aware through Idempotency-Key.

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

catalogKey

required

string

displayName

required

string

versionLabel

required

string

compatibilityRange

string

entries

required

Array<object>

>= 1 items

object

key

additional properties

customEntries

Array<object>

object

key

additional properties

key

additional properties

Example

{
  "catalogKey": "workforce",
  "displayName": "Workforce catalog",
  "versionLabel": "v1",
  "entries": [
    {
      "id": "department",
      "namespace": "profile",
      "path": "department",
      "valueType": "string",
      "cardinality": "single",
      "classification": "internal"
    }
  ]
}

Responses

200

Field catalog mutation response.

Media type application/json

object

result

required

object

id

required

string

tenantId

required

string

catalogKey

required

string

displayName

required

string

lifecycleState

required

string

activeVersion

required

object

id

required

string

versionLabel

required

string

bundleHash

required

string

compatibilityRange

required

string | null

key

additional properties

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "id": "example",
    "tenantId": "example",
    "catalogKey": "example",
    "displayName": "example",
    "lifecycleState": "example",
    "activeVersion": {
      "id": "example",
      "versionLabel": "example",
      "bundleHash": "example",
      "compatibilityRange": "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"
}