Preview SAML metadata import.

POST

/api/admin/saml-metadata/preview

Code sample: Shell / cURL

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

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

metadataXml

string

metadataUrl

string format: uri

samlProfile

string

attributePresetId

string

Example

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

Responses

200

Successful JSON response.

Media type application/json

One of:

object

object

kind

required

string

Allowed values: single

providerType

required

string

Allowed values: saml_idp saml_sp

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

object

object

kind

required

string

Allowed values: aggregate

previewId

required

string

metadataUrl

string format: uri

entityCount

required

integer

expiresAt

required

integer

verification

required

object

key

additional properties

Example

{
  "kind": "single",
  "providerType": "saml_idp",
  "config": {
    "entityId": "https://idp.example.com/metadata",
    "ssoUrl": "https://idp.example.com/sso",
    "metadataHash": "sha256:..."
  }
}