Skip to content

Update the account's SAML SSO connection. The IdP side can be configured either from a metadata URL (Stytch fetches entity id, SSO URL, and certificate) or field by field; supplying both applies the metadata URL first and then the explicit fields.

PUT
/account/sso/saml/connection
curl --request PUT \
--url https://api.siteqwality.com/account/sso/saml/connection \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "display_name": "example", "email_domain": "example", "clear_email_domain": true, "metadata_url": "example", "idp_entity_id": "example", "idp_sso_url": "example", "x509_certificate": "example" }'
Media type application/json

Body for PUT /account/sso/saml/connection. Every field is optional; only supplied fields are forwarded to Stytch.

Two ways to configure the IdP side: paste a metadata_url (Stytch fetches entity id, SSO URL, and certificate) or fill the three fields by hand.

object
display_name
string | null
email_domain
string | null
clear_email_domain

Set true to release the claimed domain (disables SSO discovery).

boolean
metadata_url
string | null
idp_entity_id
string | null
idp_sso_url
string | null
x509_certificate

PEM-encoded X.509 signing certificate from the IdP.

string | null
Example generated
{
"display_name": "example",
"email_domain": "example",
"clear_email_domain": true,
"metadata_url": "example",
"idp_entity_id": "example",
"idp_sso_url": "example",
"x509_certificate": "example"
}

Connection updated

Media type application/json

SAML connection as returned to the dashboard. Combines our row (account linkage, claimed domain) with the live Stytch object (SP-side values the customer pastes into the IdP, plus the configured IdP values).

object
connection_id
required
string
display_name
required
string
status
required

pending until the IdP side is configured, then active.

string
email_domain
string | null
acs_url

Service-provider values for the IdP side of the setup.

string | null
audience_uri
string | null
idp_entity_id

Configured IdP values (echoed back so the UI can show current state).

string | null
idp_sso_url
string | null
has_certificate
required

Whether at least one verification certificate is on file.

boolean
created_at
required
string format: date-time
Example generated
{
"connection_id": "example",
"display_name": "example",
"status": "example",
"email_domain": "example",
"acs_url": "example",
"audience_uri": "example",
"idp_entity_id": "example",
"idp_sso_url": "example",
"has_certificate": true,
"created_at": "2026-04-15T12:00:00Z"
}

Invalid field values

Missing or invalid authentication

Caller is not a super admin, or the plan does not include SSO

No SSO connection configured

The email domain is claimed by another connection

Internal server error