Skip to content
Authrim

Update a destination profile.

PUT
/api/admin/field-mapping/destination-profiles/{destinationProfileId}
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/field-mapping/destination-profiles/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "displayName": "Default OIDC claims v2", "schema": { "claims": [ { "name": "department", "valueType": "string" } ] } }'

Updates mutable destination profile fields and creates or replaces profile version metadata from the supplied schema payload.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
destinationProfileId
required
string

Destination profile 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
destinationType
required
string
Allowed values: oidc csv saml
profileKey
required
string
displayName
required
string
ownerScopeType
string
Allowed values: platform tenant client
ownerScopeId
string | null
baseProfileId
string | null
versionLabel
string
schema
required
object
key
additional properties
warningSummary
object
key
additional properties
releaseImpact
object
key
additional properties
Example 
{
  "displayName": "Default OIDC claims v2",
  "schema": {
    "claims": [
      {
        "name": "department",
        "valueType": "string"
      }
    ]
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Destination profile mutation response.

Media type application/json
object
result
required
object
id
required
string
tenantId
required
string
destinationType
required
string
Allowed values: oidc csv saml
profileKey
required
string
displayName
required
string
ownerScopeType
required
string
Allowed values: platform tenant client
ownerScopeId
string | null
baseProfileId
string | null
lifecycleState
required
string
activeVersionId
string | null
version
One of:
object
id
required
string
versionLabel
required
string
lifecycleState
required
string
schemaHash
required
string
schema
required
object
key
additional properties
validationSummary
required
object
key
additional properties
warningSummary
required
object
key
additional properties
releaseImpact
required
object
key
additional properties
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "result": {
    "destinationType": "oidc",
    "ownerScopeType": "platform"
  }
}

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 ”

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