Skip to content
Authrim

Refresh federation aggregate metadata.

POST
/api/admin/saml-federation-sources/{id}/refresh-metadata
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/saml-federation-sources/example/refresh-metadata \
  --header 'Authorization: Bearer <token>'

Fetches and verifies the aggregate metadata source immediately, records the validated document and entity summaries, and reconciles already activated providers. This manual operation is available whether scheduled polling is automatic or manual.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Federation trust source id.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Federation aggregate metadata refresh result.

Media type application/json
object
success
required
boolean
sourceId
required
string
changed
required
boolean
entityCount
required
integer
providersUpdated
required
integer
providersMissing
required
integer
providersFailed
required
integer
verificationStatus
required
string
key
additional properties
Example 
{
  "success": true,
  "sourceId": "federation_source_123",
  "changed": true,
  "entityCount": 120,
  "providersUpdated": 8,
  "providersMissing": 0,
  "verificationStatus": "verified"
}

409

Section titled “409 ”

Another refresh or trust-source update superseded this operation.

Media type application/json
object
key
additional properties
Example generated
{
  "additionalProperty": "example"
}