Update a federation trust source.

PUT

/api/admin/field-mapping/federation-trust-sources/{trustSourceId}

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/field-mapping/federation-trust-sources/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sourceType": "saml_metadata", "sourceKey": "partner-idp", "displayName": "Partner IdP metadata", "lifecycleState": "active", "protocolPayload": { "entityId": "https://idp.example.com/metadata" } }'

Updates federation trust source metadata, lifecycle state, protocol payload, anchors, and scope bindings.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

trustSourceId

required

string

Federation trust source identifier.

Header Parameters

Idempotency-Key

string

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

Request Body ^required

Media type application/json

object

sourceType

required

string

Allowed values: saml_aggregate saml_metadata saml_federation

sourceKey

required

string

displayName

required

string

lifecycleState

string

Allowed values: draft active retired

protocolPayload

object

key

additional properties

anchors

Array<object>

object

key

additional properties

scopeBindings

Array<object>

object

key

additional properties

key

additional properties

Example

{
  "sourceType": "saml_metadata",
  "sourceKey": "partner-idp",
  "displayName": "Partner IdP metadata",
  "lifecycleState": "active",
  "protocolPayload": {
    "entityId": "https://idp.example.com/metadata"
  }
}

Responses

200

Federation trust source mutation response.

Media type application/json

object

result

required

object

id

required

string

tenantId

required

string

sourceType

required

string

Allowed values: saml_aggregate saml_metadata saml_federation

sourceKey

required

string

displayName

required

string

lifecycleState

required

string

protocolPayload

object | null

createdAt

integer

updatedAt

integer

snapshotHash

string

key

additional properties

key

additional properties

Example

{
  "result": {
    "sourceType": "saml_aggregate"
  }
}

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

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

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

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