Skip to content
Authrim

Delete a Mapping Set.

DELETE
/api/admin/identity-mapping/sets/{id}
Code sample: Shell / cURL 
curl --request DELETE \
  --url https://auth.example.com/api/admin/identity-mapping/sets/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: example'

Deletes a Mapping Set with its versions. A set that is switched on is switched off and deleted by the same request, in one atomic batch: there is no separate step of switching it off first (the older DELETE /api/admin/field-mapping/field-mapping-sets/{fieldMappingSetId} still refuses an active set). The request is refused with 409 (reason referenced or scan_incomplete, with references) while a default, an app, a SAML provider, a credential profile, a federation trust source or SCIM still names the set, or when where it is used could not be checked everywhere; nothing is changed then. If-Match (optional) carries the content_version (or ETag) read last; another value is refused with 409 and nothing is deleted. Whether or not it is sent, the batch starts with a check that the set is still as this request read it (the version in use, else the one saved last): a save or a switch by someone else in between fails the check with 409 and deletes nothing. A platform set needs platform authority (403); a set another tenant owns, and one that does not exist, answer 404 (a repeat without an Idempotency-Key match after the set is gone is a 404; a repeat with the same key is answered with the stored answer). Idempotency-Key is required. One audit record (identity_mapping.set.deleted, with whether the set was switched on). Rate limited with the strict profile.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string
>= 1 characters <= 200 characters

Mapping Set identifier.

Header Parameters

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

Required replay-protection key retained for 15 minutes.

If-Match
string

The content_version (or ETag) of the set as it was read.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The Mapping Set was deleted.

Media type application/json
object
id
required
string
owner
required
string
Allowed values: tenant platform
deleted
required
boolean
key
additional properties
Example 
{
  "owner": "tenant"
}

400

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

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

404

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

Section titled “409 ”

The change was refused: the Mapping Set is named somewhere (referenced), the version would not meet what the references need (would_break_references), or where it is used could not be checked everywhere (scan_incomplete).

Media type application/json
object
error
required
string
Allowed values: conflict
error_description
required
string
reason
required
string
Allowed values: referenced scan_incomplete would_break_references
references
required
object
count
required

Everything found, other tenants’ included.

integer
countIsLowerBound
required

True when a place held more rows than were read.

boolean
items
required

The first references the caller may see in full.

Array<object>
object
kind
required
string
Allowed values: platform_default tenant_default client saml_provider credential_profile federation_trust_source scim
tenantId

The tenant the reference is in. Absent for the platform’s own default.

string
clientId
string
providerId
string
providerType
string
entityId

The entity ID of the SAML partner the provider is configured for.

string
profileId
string
versionId
string
versionLifecycleState
string
credentialConfigurationId
string
trustSourceId

A federation trust source whose runtime resolution names the set.

string
federationRole
string
Allowed values: saml_idp saml_sp
role
string
Allowed values: issuance verification
pinnedVersionId

A Mapping Set version the reference pins.

string
pinnedSnapshotHash

The compiled snapshot a credential profile version was published with.

string
viaMappingSetId

When asked about a Destination Profile, the Mapping Set the reference is through.

string
key
additional properties
itemsTruncated
required
boolean
otherTenants

References in other tenants the caller may not see, as counts only.

object
referenceCount
required
integer
tenantCount
required
integer
scanned
required

False when the other tenants’ Core databases were not read (the caller has no global authority): the counts then hold only what the Admin database knows.

boolean
key
additional properties
scanComplete
required
boolean
unscanned
required
object
count
required
integer
items
required
Array<object>
object
area
required
string
Allowed values: platform_settings tenant_settings credential_profiles federation_trust_sources tenant_clients tenant_saml scim_settings tenant_directory tenant_limit other_tenants
tenantId

Given only for the caller’s own tenant, or to a caller with global authority.

string
reason
required

A fixed code (for example core_database_unavailable, no_such_table).

string
key
additional properties
key
additional properties
violation

Only on would_break_references, the condition the version would fail.

object
code
string
Allowed values: destination_profile_invalid platform_set_unsafe snapshot_inactive pinned_version_replaced activation_scope_mismatch saml_destination_policy_mismatch saml_attribute_descriptor_renames_field
message
string
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "error": "conflict",
  "reason": "referenced",
  "references": {
    "items": [
      {
        "kind": "platform_default",
        "federationRole": "saml_idp",
        "role": "issuance"
      }
    ],
    "unscanned": {
      "items": [
        {
          "area": "platform_settings"
        }
      ]
    },
    "violation": {
      "code": "destination_profile_invalid"
    }
  }
}

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 ”

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