List Mapping Sets.

GET

/api/admin/identity-mapping/sets

Code sample: Shell / cURL

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

Lists the Mapping Sets the calling tenant owns together with the platform’s, which every tenant can read, in the form of the Mapping Set facade: whether each is switched on (enabled), its owner (tenant or platform), the version in use (active_version_id; null when the set is off) and content_version. The content itself is read with GET /api/admin/identity-mapping/sets/{id}. A set another tenant owns is never listed. Rate limited with the strict profile.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

The Mapping Sets of the tenant and the platform’s.

Media type application/json

object

sets

required

Array<object>

The fields every answer about a Mapping Set carries. The detail and the save answers add to them, so the schema is open.

object

id

required

string

owner

required

string

Allowed values: tenant platform

field_mapping_key

required

string

display_name

required

string

description

string

nullable

enabled

required

Whether an activation is in use.

boolean

active_version_id

required

string

nullable

version_label

The label of the version the set is now (the one in use, else the last saved).

string

nullable

content_version

required

What the set is now: the ID of the version in use, else of the version saved last, else none. Changes with every save; sent as If-Match.

string

created_at

integer

updated_at

integer

key

additional properties

Example

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

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

429

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