Skip to main content

Get SAML auth settings

GET /api/admin/auth/saml/settings

Returns the current settings for SAML authentication

Request​

Responses

samlSettingsResponseSchema

Schema
  • enabled boolean

    Possible values: [true]

    Whether to enable or disable SAML 2.0 for this instance

  • entityId string

    The SAML 2.0 entity ID

  • signOnUrl string

    Which URL to use for Single Sign On

  • certificate string

    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.

  • enableGroupSyncing boolean

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

  • groupJsonPath string

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

Loading...