Sign in
instance

Partially update SAML provider policy or disable the provider.

Changed on

Omitted members preserve their stored values. Metadata, entityID and certificate changes cannot ride this path: they remain behind the metadata diff-and-confirm ceremony. Disabling sweeps this provider's sessions. This additive endpoint supports the locked update and disable CLI spellings without requiring unreadable metadata input.

patch/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
assurance_policystring[] nullable
allow_email_nameidboolean
force_sign_requestsboolean
enabledboolean

Response

The updated provider.

slugstring required
display_namestring required
kind'saml' required
entity_idstring required

Byte-exact IdP entityID; immutable after create.

acs_urlstring uri required
sso_redirect_urlstring uri required
signing_certificate_fingerprintsstring[] required
assurance_policystring[] nullable
allow_email_nameidboolean required
force_sign_requestsboolean required
metadata_source'file' | 'url' required

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

metadata_urlstring uri nullable
metadata_signedboolean required
metadata_signing_fingerprintstring nullable
metadata_valid_untilstring date-time

RFC 3339 UTC, microsecond precision.

enabledboolean required
row_versioninteger required
created_atstring date-time required

RFC 3339 UTC, microsecond precision.

updated_atstring date-time required

RFC 3339 UTC, microsecond precision.

Changes

  • 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

  • f84a1cd8a05aRevision changes
    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status