Configure SAML SSO for other IdPs

You can configure the Splunk platform to use any identity provider that is compliant with version 2.0 of the Security Assertion Markup Language (SAML) for single sign-on operations.

Use this topic for general configuration instructions to connect an IdP with the Splunk platform. There might be exceptions or differences in the process of configuring an IdP to work with the platform, depending upon the IdP you use. For assistance with configuration procedures that are not documented in this chapter, contact Splunk Support.

You can upload a metadata file from your IdP to populate some of the fields that appear in this procedure. While the Splunk platform supports a number of IdP metadata file formats, it might not be able to read through part or all of your specific metadata file. In this case, you will need to put in IdP configuration parameters manually.

After you configure the Splunk platform to use your SAML authentication system, you can authorize groups on your IdP to log in by mapping them to Splunk user roles.

The Splunk platform does not support the encryption of individual SAML attributes. It encrypts the entire SAML assertion.

For information about supported and tested IdPs, see Configure single sign-on with SAML.

Prerequisites

Verify that your system meets all of the requirements. See Configure single sign-on with SAML.

1. In the Settings menu, select Authentication method.
2. Select SAML as your authentication type.
3. Click Configure Splunk to use SAML.
4. On the SAML Groups page, click SAML Configuration.
5. Browse and select your metadata file, or copy and paste your metadata directly into the text window. Refer to your IdP's documentation if you are not sure how to get your metadata file.
   

   If you receive an error message that the Splunk platform is unable to process the payload received when you upload or paste your IdP metadata file, then you must manually provide all of the IdP information, as described in the rest of this procedure. This does not mean that your IdP is incompatible with the Splunk platform.

6. In General Settings, provide the following information.

   Single Sign on URL.	This field is populated automatically by your selected metadata file. It is the protected endpoint on your IdP to which Splunk sends authentication requests. Your users use this URL for SSO login. To access the login page once SAML is enabled, append the full login URL (/account/login) with loginType=Splunk. Users can also log into their local Splunk account by navigating directly to splunkweb:port/en-US/account/login?loginType=Splunk
   Single Log Out URL.	This field is populated automatically by the metadata file and is the IdP protocol endpoint. If you do not provide this URL, the user will not be logged out.
   IdP's certificate path	This value can be a directory or a file, depending on your IdP requirements. If you provide a file, Splunk uses that file to validate authenticity of SAML response. If you provide a directory, Splunk looks for all the certificates that are present as children of the directory and tries to validate SAML response with each one of them, if Splunk fails to validate authenticity with all of them, response is not considered authentic. When configuring SAML on a search head cluster, make sure you configure the same certificate for each search head.
   Entity ID.	This field is the entity ID as configured in the SP connection entry in your IdP.
   Sign AuthRequest.	Select this option.
   Sign SAML Response.	Select this option.

7. If you use PingIdentity as your IdP, in Attribute Query, provide the following information so you can create scheduled searches later. These fields are not required for creating scheduled searches with Okta, Azure AD, or AD FS.

   Attribute Query URL.	This field is the endpoint on the IdP to which queries over SOAP are sent. The format is as follows: <urn:oasis:names:tc:SAML:2.0:attrname-format:uri>
   Sign attribute query request	Verify that this field is selected.
   Sign attribute query response	Verify that this field is selected.

8. In Advanced settings, provide the following information.

   Attribute Alias Role	Use this field to specify a new attribute name on any IdP and then configure an alias on the Splunk side for any of the 3 attributes. If you have configured the AD FS built-in "Role" attribute to be returned and this has the AD group information, specify http://schemas.microsoft.com/ws/2008/06/identity/claims/role. This value tells Splunk the attribute that contains the role information in the SAML response returned. If you have configured Azure AD, specify http://schemas.microsoft.com/ws/2008/06/identity/claims/groups.
   Attribute Alias Real Name	Populate this field if you use Azure AD as your IdP. This value tells Splunk Enterprise where to map the real name in the SAML response returned. Enter http://schemas.microsoft.com/identity/claims/displayname.
   Attribute Alias Mail	Populate this field if you use Azure AD as your IdP. This value maps the alias to the user email addresses in the SAML response returned. Enter http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress.
   FQDN - Host Name or IP of the load balancer	Set to: https://sh1.STACKID.splunkcloud.com. This setting works for a Splunk deployment with Single Search Head Setup or a Search Head Cluster Setup. You must provide an address if you use load balancing with a search head cluster.
   (Optional) Redirect Port	Provide a redirect port for the load balancer described in the previous field. For Okta set it to "0" (Zero).

9. Click Save.

Next Steps

Map SAML groups to Splunk roles