コンテンツにスキップ
Authrim

Create a Mapping Set with its content, and switch it on.

POST
/api/admin/identity-mapping/sets
Code sample: Shell / cURL 
curl --request POST \
  --url 'https://auth.example.com/api/admin/identity-mapping/sets?preview=false' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "display_name": "example", "description": "example", "field_mapping_key": "example", "owner_scope_type": "tenant", "enabled": true, "confirm_impact": 1, "content": { "catalogVersionId": "example", "compatibilityRange": "example", "sourceProfileIds": [ "example" ], "rules": [ { "additionalProperty": "example" } ] } }'

Creates a Mapping Set and saves its content in one call (the set, a version, its publication and compile, and the activation), as PUT /api/admin/identity-mapping/sets/{id} does for a set that exists. The body is the same, with field_mapping_key (required here, unique among the sets of the owner) and owner_scope_type: platform creates the platform’s set, which needs platform authority (403 otherwise); any other value creates the calling tenant’s. The set is given a server-made ID (a set ID cannot be chosen). Answers 201. ?preview=true writes nothing (see the PUT). A key already in use answers 409 conflict. If a step fails, the set is not left behind (see the PUT for stage_failed). A set that releases into a Destination Profile that is not an OIDC one is refused with 400 unsupported_destination. Idempotency-Key is required (8 to 128 characters; not for a preview). Rate limited with the strict profile.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
required
string
>= 1 characters <= 255 characters

Required replay-protection key retained for 15 minutes.

Query Parameters

Section titled “Query Parameters ”
preview
boolean

With true nothing is written; the answer says what the save would do (see the PUT).

Request Body required

Section titled “Request Body required ”
Media type application/json
object
display_name
required
string
<= 200 characters
description
string
nullable <= 2000 characters
field_mapping_key

Required to create (unique among the owner’s sets). On a PUT it can be left out or must be the set’s own key.

string
<= 200 characters
owner_scope_type

Only when creating: platform creates the platform’s set (platform authority). On a PUT it can be left out or must be the set’s owner.

string
Allowed values: tenant platform
enabled

True switches the saved version on, in place of the one in use. False saves it and ends the activation (refused while something names the set).

boolean
default: true
confirm_impact

The number of references seen last (preview or usage). Required to change a set that something names.

integer
content
required

What a version holds, in the form the version create takes (camelCase), and the catalog version it is compiled against. The version label and the author are made by the server.

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
key
additional properties
key
additional properties

Responses

Section titled “ Responses ”

200

Section titled “200 ”

What a save would do (nothing was written).

Media type application/json
object
preview
required
boolean
valid
required
boolean
id
string
nullable
owner
string
would_create
boolean
enabled
boolean
content_version
string
stage_failed

Only when valid is false.

string
Allowed values: validate
error

Only when valid is false.

string
error_description

Only when valid is false.

string
validation
object
ok
boolean
compile
object
ok
boolean
catalog_version_id
string
activation
object
scope
object
key
additional properties
deactivation_refusal

Why switching the set off would be refused now, if it would.

object
key
additional properties
diff
object
before
object
rules
integer
edges
integer
transforms
integer
validation_rules
integer
release_rules
integer
conflict_rules
integer
released_claims

The names of the claims released. Never a value.

Array<string>
after
object
rules
integer
edges
integer
transforms
integer
validation_rules
integer
release_rules
integer
conflict_rules
integer
released_claims

The names of the claims released. Never a value.

Array<string>
key
additional properties
claims_added
Array<string>
claims_removed
Array<string>
key
additional properties
references
object
count
integer
count_is_lower_bound
boolean
scan_complete
boolean
key
additional properties
confirm_impact_required
boolean
key
additional properties
Example 
{
  "preview": true,
  "stage_failed": "validate"
}

201

Section titled “201 ”

The set was saved (200 for a set that existed, 201 for one that was created), or, with preview=true, what a save would do.

Media type application/json
One of:
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
created
boolean
version_id

The version this save created.

string
snapshot_id
string
previous_content_version
string
summary
object
rules
integer
edges
integer
transforms
integer
validation_rules
integer
release_rules
integer
conflict_rules
integer
released_claims

The names of the claims released. Never a value.

Array<string>
key
additional properties
Example 
{
  "owner": "tenant"
}

Headers

Section titled “Headers ”
ETag
string

The content_version after the save, quoted.

400

Section titled “400 ”

The save was refused or a step failed. stage_failed names the step when the content was looked at or written; version_id and version_discarded are given when a version was created.

Media type application/json
object
error
required

For example invalid_request, unsupported_destination, conflict, impact_confirmation_required, idempotency_conflict, result_unknown, internal_error.

string
error_description
required
string
stage_failed
string
Allowed values: validate create_version publish compile activate
version_id

The version this save created before it failed.

string
nullable
version_discarded

Whether that version was removed.

boolean
reason
string
Allowed values: referenced scan_incomplete would_break_references
references

The references that made a change a conflict, as in MappingSetInUseError; for impact_confirmation_required, references.count is the number to confirm.

object
key
additional properties
key
additional properties
Example 
{
  "stage_failed": "validate",
  "reason": "referenced"
}

401

Section titled “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

Section titled “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"
}

409

Section titled “409 ”

The save was refused or a step failed. stage_failed names the step when the content was looked at or written; version_id and version_discarded are given when a version was created.

Media type application/json
object
error
required

For example invalid_request, unsupported_destination, conflict, impact_confirmation_required, idempotency_conflict, result_unknown, internal_error.

string
error_description
required
string
stage_failed
string
Allowed values: validate create_version publish compile activate
version_id

The version this save created before it failed.

string
nullable
version_discarded

Whether that version was removed.

boolean
reason
string
Allowed values: referenced scan_incomplete would_break_references
references

The references that made a change a conflict, as in MappingSetInUseError; for impact_confirmation_required, references.count is the number to confirm.

object
key
additional properties
key
additional properties
Example 
{
  "stage_failed": "validate",
  "reason": "referenced"
}

413

Section titled “413 ”

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

425

Section titled “425 ”

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

Section titled “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

Section titled “500 ”

The save was refused or a step failed. stage_failed names the step when the content was looked at or written; version_id and version_discarded are given when a version was created.

Media type application/json
object
error
required

For example invalid_request, unsupported_destination, conflict, impact_confirmation_required, idempotency_conflict, result_unknown, internal_error.

string
error_description
required
string
stage_failed
string
Allowed values: validate create_version publish compile activate
version_id

The version this save created before it failed.

string
nullable
version_discarded

Whether that version was removed.

boolean
reason
string
Allowed values: referenced scan_incomplete would_break_references
references

The references that made a change a conflict, as in MappingSetInUseError; for impact_confirmation_required, references.count is the number to confirm.

object
key
additional properties
key
additional properties
Example 
{
  "stage_failed": "validate",
  "reason": "referenced"
}

503

Section titled “503 ”

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