Skip to main content

Get SAML auth settings

GET /api/admin/auth/saml/settings

Returns the current settings for SAML authentication

Request​

Responses

samlSettingsSchema

Schema
  • enabled boolean

    Is SAML authentication enabled

  • entityId string required

    The SAML 2.0 entity ID

  • signOnUrl string required

    Which URL to use for Single Sign On

  • certificate string required

    The X509 certificate used to validate requests

  • signOutUrl string

    Which URL to use for Single Sign Out

  • spCertificate string

    Signing certificate for sign out requests

  • autoCreate boolean

    Should Unleash create users based on the emails coming back in the authentication reply from the SAML server

  • emailDomains string

    A comma separated list of email domains that Unleash will auto create user accounts for.

  • defaultRootRole string

    Possible values: [Viewer, Editor, Admin]

    Assign this root role to auto created users

  • defaultRootRoleId number

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

Loading...