List field mapping sets.

GET

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

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/field-mapping/field-mapping-sets \
  --header 'Authorization: Bearer <token>'

Lists the field mapping sets the tenant owns together with the platform’s, which every tenant can read. Each set carries its key, display name, owner (tenant or platform), lifecycle state, and timestamps. A set another tenant owns is never listed. A platform set can be read but not changed with tenant authority.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Field mapping set list response.

Media type application/json

object

fieldMappingSets

required

Array<object>

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

{
  "fieldMappingSets": [
    {
      "owner": "tenant"
    }
  ]
}

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