Skip to main content

saveSsoSettings

Creates or updates the active account's SAML SSO settings. When the request leaves SSO enabled and changes the provider settings, enabled, or required, nothing is saved yet: needsValidation is true, and the user's browser must POST validationToken as the validation_token form field to validationUrl and finish an identity provider sign-in within five minutes, which saves the returned proposal. Otherwise the settings are saved immediately. Requires SSO edit access.

saveSsoSettings(
  enabled: Boolean!
  required: Boolean!
  spConfiguration: SsoSpConfigurationInput!
  idpConfiguration: SsoIdpConfigurationInput!
  emailDomain: String
  organizationName: String
  provisioningRules: [SsoProvisioningRuleInput!]
): SaveSsoSettingsResult!

Arguments​

saveSsoSettings.enabled ● Boolean! non-null scalar​

Whether SAML SSO is enabled; false also forces required to false. Enabling requires all identity provider fields.

saveSsoSettings.required ● Boolean! non-null scalar​

Whether team members must sign in through SAML SSO; false also allows other login methods. Saved as false when enabled is false.

saveSsoSettings.spConfiguration ● SsoSpConfigurationInput! non-null input​

Service provider settings matching the identity provider setup; preserve the ID using ssoSettings.spConfiguration.entityId as entityId.

saveSsoSettings.idpConfiguration ● SsoIdpConfigurationInput! non-null input​

Identity provider settings; all fields must be nonblank when enabled is true. Send the saved values from ssoSettings when disabling SSO.

saveSsoSettings.emailDomain ● String scalar​

Email domain only, such as example.com; a new domain must belong to one of the account's sites that has received tracking data. Omission clears it.

saveSsoSettings.organizationName ● String scalar​

Organization display name; whitespace is trimmed and omission clears it.

saveSsoSettings.provisioningRules ● [SsoProvisioningRuleInput!] list input​

Ordered, nonempty rules; the first match applies after membership and invitation checks. End with one ANYONE condition; omit to preserve saved rules.

Type​

SaveSsoSettingsResult object​

Saved settings or a proposed configuration returned by saveSsoSettings, with test-login details when validation is needed.