Skip to content
Authrim

Activate a field mapping version.

Deprecated
POST
/api/admin/field-mapping/field-mapping-sets/{fieldMappingSetId}/versions/{fieldMappingVersionId}/activate
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/field-mapping-sets/example/versions/example/activate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "snapshotId": "mapping_snapshot_123", "activationScope": { "clients": [ "web-app" ] } }'

Activates a compiled field mapping version for the supplied activation scope. Requires a compiled snapshot id in the request body. A set the platform owns applies to every tenant, so its activation is stored with an empty scope (a tenant-wide scope is accepted and normalised; a narrower one is refused), and it must release into exactly one OIDC Destination Profile that the platform owns. While the set has a version in use and is named by a default, an app, a SAML provider, a credential profile or SCIM, the version put in its place must still release into exactly one active Destination Profile of the kind in use (and, for a platform set, hold only what a platform set may), keep the version or snapshot that an app, a SAML provider or a credential profile is bound to, and the scope of the new activation must still apply to the context of each of them; otherwise 409 with reason would_break_references and the failed condition in references.violation. Mappings that read what comes in (SAML identity providers, SCIM) and credential mappings need no Destination Profile. The profiles counted are the ones the runtime counts: those the version’s edges name together with the destinationProfileId of the activation scope. A SAML provider’s saved release policy and attribute names must still hold for the new version’s profile, by the rules that save the provider’s configuration. When more references exist than are read in full, the change is refused as scan_incomplete; the list in references is then a lower bound (countIsLowerBound) and scanComplete is false. 409 scan_incomplete when where the set is used could not be checked everywhere. Deprecated: this is one of the five steps (set, version, publish, compile, activate) that POST /api/admin/identity-mapping/sets and PUT /api/admin/identity-mapping/sets/{id} run in one call, with the same checks and a release safety check made when the content is saved. It keeps working unchanged; new clients use the Mapping Set facade.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
fieldMappingSetId
required
string

Field mapping set identifier.

fieldMappingVersionId
required
string

Field mapping version identifier.

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string

Idempotency key for state-changing operations that support replay protection.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
snapshotId
required
string
activationScope
required
object
key
additional properties
holderId
string
key
additional properties
Example 
{
  "snapshotId": "mapping_snapshot_123",
  "activationScope": {
    "clients": [
      "web-app"
    ]
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Field mapping activation response.

Media type application/json
object
result
required
object
id
required
string
tenantId
required
string
fieldMappingSetId
required
string
fieldMappingVersionId
required
string
snapshotId
string
lifecycleState
required
string
activatedAt
integer
holderId
string
alreadyActive
boolean
key
additional properties
key
additional properties
Example generated
{
  "result": {
    "id": "example",
    "tenantId": "example",
    "fieldMappingSetId": "example",
    "fieldMappingVersionId": "example",
    "snapshotId": "example",
    "lifecycleState": "example",
    "activatedAt": 1,
    "holderId": "example",
    "alreadyActive": true
  }
}

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

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