SAML SP

The SAML SP screen allows you to view, add, and update the SP settings for your site.

SAML SP list

Accessing the screen

In the left sidebar menu, under "SETTINGS", click [External system integration] -> [SAML SP].

Image from Gyazo

Item descriptions

Image from Gyazo

ItemDescription
EnableStatus of the SAML SP.
Image (fetched from Gyazo): Enabled
Image (fetched from Gyazo): Disabled
Login SAML SP nameName of the SP.
Entity IDSAML entity ID.
Valid untilExpiration date and time of the IdP.
Updated onDate and time of last update to the SAML SP.

SAML SP editor

Accessing the screen

In the left sidebar menu, under "SETTINGS", click [External system integration] -> [SAML SP].

Image from Gyazo

On the SAML SP list screen, click the name of the SP you want to edit.

Image from Gyazo

Item descriptions

SAML SP editor

Image from Gyazo

ItemDescription
Login SAML SP nameName of the SP. To enable the SP, check the "Enable" box and specify the required IdP metadata below.
Target domainTarget domain of the SAML SP (admin panel URL or API domain).
Login SAML SP ACS URIStart URL for the SP-initiated SAML authentication flow.
Entity IDSAML entity ID.
XML config file for IDPImport a SAML 2.0-compliant XML file to configure the IdP.
(Note: Instead of uploading a file, you can also click [Don't have config file? Please click here.] to manually enter the following data in text format.
  • Certificates: Upload a certificate file from your local drive.
  • IdP URL: URL of the IdP.
  • IdP entity ID: Entity ID given by the service provider.
  • Valid until: Expiration date and time of the IdP.)
(API) Generate grant tokenCheck the box to generate a grant token for the API call.
Automatic user registrationCheck the "Enable" box to automatically register non-members who log in with SAML. Specify the user groups for automatically registered new members using the dropdown list.
Return URL (success)URL that user will be redirected to upon successfully logging in.
Return URL (error)URL that user will be redirected to if login fails.
Allow IdP initiated flowCheck this box to enable IdP initiated flow.

Actions

Image from Gyazo

ButtonDescription
UpdateApply all changes made on this screen.
Download metadataDownload the current SP metadata in SAML 2.0-compliant XML format.
DeleteDelete the current SP.