Refresh SAML provider metadata.

POST

/api/admin/saml-providers/{id}/refresh-metadata

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/saml-providers/example/refresh-metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "metadataUrl": "https://idp.example.com/metadata.xml" }'

Fetches metadata from the configured or supplied HTTPS metadata URL and updates the provider configuration, certificate validation state, and metadata refresh status.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

SAML provider id.

Request Body

Media type application/json

object

metadataUrl

string format: uri

Example

{
  "metadataUrl": "https://idp.example.com/metadata.xml"
}

Responses

200

Successful JSON response.

Media type application/json

object

success

required

boolean

changed

required

boolean

expired

boolean

config

required

object

entityId

string

ssoUrl

string format: uri

acsUrl

string format: uri

certificate

string

metadataUrl

string format: uri

metadataXml

string

nameIdFormat

string

metadataNameIdFormats

Array<string>

key

additional properties

enabled

required

boolean

metadataRefreshStatus

required

object

key

additional properties

Example

{
  "success": true,
  "changed": true,
  "config": {
    "entityId": "https://idp.example.com/metadata"
  },
  "enabled": true,
  "metadataRefreshStatus": {
    "diff": {
      "changed": true
    }
  }
}