Skip to main content
PATCH
/
settings
/
saml
Update Saml Settings
curl --request PATCH \
  --url https://api.example.com/settings/saml \
  --header 'Content-Type: application/json' \
  --cookie fastapiusersauth= \
  --data '
{
  "saml_enabled": true,
  "saml_enforced": false,
  "saml_idp_metadata_url": "<string>"
}
'
{}

Authorizations

fastapiusersauth
string
cookie
required

Body

application/json
saml_enabled
boolean
default:true

Whether SAML is enabled.

saml_enforced
boolean
default:false

Whether SAML is enforced. If true, users can only use SAML to authenticate. Requires SAML to be enabled.

saml_idp_metadata_url
string | null

Response

Successful Response