Read a Mapping Set with its content.

GET

/api/admin/identity-mapping/sets/{id}

Code sample: Shell / cURL

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

Reads the Mapping Set with the content of the version in use (the version saved last when the set is off), in the form PUT /api/admin/identity-mapping/sets/{id} takes, so that it can be edited and sent back. enabled, owner (tenant or platform), active_version_id, content_version (also sent as ETag) and references (how many things name the set: only the count, the places are read with GET /api/admin/identity-mapping/usage; for a platform set only what the Admin database knows is counted, scan_complete says whether that is all) are given. The release rules and conflict rules of a version are stored on the version, not on a rule, so they are spread over its rules in order, each rule holding up to the limit of a rule (250 release rules, 100 conflict rules) before the next one, so that the content is accepted by the PUT as read. A set another tenant owns, and one that does not exist, answer 404; a platform set can be read by every tenant administrator. Rate limited with the strict profile.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

>= 1 characters <= 200 characters

Mapping Set identifier.

Responses

200

A Mapping Set with the content of the version in use.

Media type application/json

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

content

Null when the set has no version.

object

catalogVersionId

required

The catalog version the content is compiled against.

string

compatibilityRange

string

sourceProfileIds

Source Profile references validated for mappingRequired fields. Not given back by a GET (the edges carry the profile IDs).

Array<string>

rules

required

Rules with ruleKey, ruleKind, action, priority, scope, condition, metadata, edges (sourceRef, targetRef, edgeKind), transforms (edgeIndex, operation, parameters), validationRules, releaseRules and conflictRules, as in FieldMappingVersionCreateRequest. The rules release into exactly one OIDC Destination Profile (named by targetRef.profileId).

Array<object>

<= 250 items

object

key

additional properties

references

Null when the references could not be counted.

object

count

integer

count_is_lower_bound

boolean

scan_complete

boolean

Example

{
  "owner": "tenant"
}

Headers

ETag

string

The content_version, quoted.

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

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