Register a federation metadata document.

POST

/api/admin/field-mapping/federation-metadata-documents

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/field-mapping/federation-metadata-documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "trustSourceId": "federation_trust_source_123", "documentType": "saml_metadata", "documentHash": "sha256:abc123", "validationState": "valid" }'

Registers a federation metadata document for a trust source, including document hash/reference and entity summaries.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Header Parameters

Idempotency-Key

string

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

Request Body ^required

Media type application/json

object

trustSourceId

required

string

documentType

required

string

sourceUrl

string | null

documentHash

required

string

documentRef

string | null

validationState

string

Allowed values: pending valid invalid warning

entitySummaries

Array<object>

object

key

additional properties

key

additional properties

Example

{
  "trustSourceId": "federation_trust_source_123",
  "documentType": "saml_metadata",
  "documentHash": "sha256:abc123",
  "validationState": "valid"
}

Responses

200

Federation metadata document registration response.

Media type application/json

object

result

required

object

id

required

string

trustSourceId

required

string

validationState

required

string

key

additional properties

key

additional properties

Example ^generated

{
  "result": {
    "id": "example",
    "trustSourceId": "example",
    "validationState": "example"
  }
}

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