Admin APIAuth

Update SAML auth settings

Enterprise feature

Updates the settings for SAML Authentication

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Request

samlSettingsSchema
SamlSettingsSchema0objectRequired
OR
SamlSettingsSchema1objectRequired

Response

samlSettingsResponseSchema
enabledboolean or null
Whether to enable or disable SAML 2.0 for this instance
entityIdstring or null
The SAML 2.0 entity ID
signOnUrlstring or null
Which URL to use for Single Sign On
certificatestring or null
The X509 certificate used to validate requests
signOutUrlstring or null
Which URL to use for Single Sign Out
spCertificatestring or null
Signing certificate for sign out requests
autoCreateboolean or null
Should Unleash create users based on the emails coming back in the authentication reply from the SAML server
emailDomainsstring or null
A comma separated list of email domains that Unleash will auto create user accounts for.
defaultRootRoleenum or null
Assign this root role to auto created users
Allowed values:
defaultRootRoleIddouble or null

Assign this root role to auto created users. Should be a role ID and takes precedence over defaultRootRole.

enableGroupSyncingboolean or null

Should we enable group syncing. Refer to the documentation Group syncing

groupJsonPathstring or null
Specifies the path in the SAML token response from which to read the groups the user belongs to.

Errors