Sign in
instance

Create or reconfigure a SAML provider from pinned metadata.

Changed on

The configured entityID selects exactly one metadata descriptor and is immutable after create. File and one-shot URL sources enter the same diff-and-confirm ceremony; certificate, endpoint and assurance-policy changes sweep this provider's sessions. SAML never provisions accounts, so no provisioning member exists in this request schema.

put/api/v1/instance/saml-providers/{slug}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/instance/saml-providers/{slug}
  • Auth: HTTP bearer

Request body

display_namestring required
entity_idstring required

Configured byte-exact IdP entityID used to select exactly one EntityDescriptor from metadata; immutable after create.

metadata_source'file' | 'url' required

Closed source set; URL means one-shot admin-initiated fetch, never a poller.

metadata_documentstring nullable

Raw IdP metadata XML for a file-backed configuration.

metadata_urlstring uri nullable

One-shot WebPKI URL; redirects off-origin are refused.

confirmed_fingerprintsstring[]

Fingerprints explicitly confirmed in the current ceremony.

confirmed_endpointsstring[]

New endpoint URLs explicitly confirmed in the current ceremony.

assurance_policystring[] nullable

Accepted AuthnContextClassRef values; null means single-factor.

allow_email_nameidboolean required

Explicit opt-in to opaque emailAddress NameID values; never email linking.

force_sign_requestsboolean required

Force signed AuthnRequests even when metadata does not demand them.

enabledboolean required

Response

Applied provider or metadata diff requiring explicit confirmation.

appliedboolean required
required_fingerprintsstring[] required
required_endpointsstring[] required

Changes

  • f24ca8785e72Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • 54b2780eec85Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status