This page provides guidelines for configuring basic SAML on-premises authentication.

Configure SAML Authentication for the Identity Provider

You can configure an identity provider to enable single sign-on access to the Splunk AppDynamics Controller using the SAML 2.0 protocol. Refer to your identity provider documentation for detailed configuration instructions.

SAML Settings for the Identity Provider

Your identity provider requires the following information about your Splunk AppDynamics Controller for the SAML settings. The <controller_domain> is the domain of your on-premises Controller.

SettingDescription
Audience URI (Service Provider Entity ID)

The unique identifier intended for the SAML assertion. In most cases, it is the Service Provider Entity ID, unless the Service Provider decides to use a different identifier.

  • Syntax: http://<controller_domain>/controller
  • Example: http://yourcompany.customer-host/controller
Single Sign-On URL (Assertion Consumer URL)

The Splunk AppDynamics endpoint to service SAML Authentication. You must specify your Splunk AppDynamics account name with the query string parameter accountName as shown:

  • Syntax: http://<controller_domain>/controller/saml-auth?accountName=<account_name>
  • Example: http://yourcompany.customer-host/controller/saml-auth?accountName=myaccount

SAML Attributes for the Identity Provider (Recommended)

You set the attributes with your identity provider that map to SAML users in your Splunk AppDynamics account. When the attributes are set, the user information displays on the Controller, such as the username and email. Changes to these attributes on the IdP will update the SAML attributes on the Controller when the user successfully logs in.

This table shows how IdP example attributes map to the Username AttributeDisplay Name Attribute, and the Email Attribute settings of the Controller:

Example Attribute NameExample Attribute ValuesDescription
Username AttributeUser.loginName

Unique identifier for the user in the SAML response. This value corresponds to the Splunk AppDynamics username field. The value must be unique among all SAML users in the Splunk AppDynamics account.

If you do not map a username, Splunk AppDynamics obtains the username from the NameId containing the emailaddress field.

Display Name AttributeUser.fullName

Informal name for the user corresponding to the Splunk AppDynamics Name field. 

Email AttributeUser.email

User email address, corresponding to Splunk AppDynamics email field.

 

Configure SAML Authentication from the Controller

To configure SAML authentication from the Controller:

Configure SAML Authentication

  1. Sign in to your Controller as the Account Owner. See Who Can Configure SAML

  2. As a user with Splunk AppDynamics account administrator privileges in the Controller UI, click Settings Settings > Administration

  3. Click the Authentication Provider tab and select SAML.

  4. From Authentication Provider > SAML, enter these SAML configuration settings:

    • Login URL: The SAML Login URL where the Controller routes Service Provider (SP)-initiated login requests. This login URL is required.

    • Logout URL: The URL where the Controller redirects users after they log out. If you do not specify a logout URL, users will get the Splunk AppDynamics login screen when they log out. 

    • Certificate: The X.509 certificate from your identity provider configuration. Paste the certificate between the BEGIN CERTIFICATE and END CERTIFICATE delimiters. Avoid duplicating BEGIN CERTIFICATE and END CERTIFICATE delimiters from the source certificate itself.  

Configure SAML Attribute Mapping (Optional)

From SAML Attribute Mappings, you can specify how the Splunk AppDynamics Controller identifies SAML-authenticated users:

  • Username Attribute: Unique identifier for the user in the SAML response. This value corresponds to the Splunk AppDynamics username field, so the value must be unique among all SAML users in the Controller account. Given the sample response below, the value for this setting would be User.OpenIDName.
  • Display Name Attribute: The informal name for the user corresponding to the Splunk AppDynamics Name field. Given the sample response, this value would be User.fullName.
  • Email Attribute: The user's email address, corresponding to the Splunk AppDynamics email field. Given the sample response, this value would be User.email.

Map SAML-Authenticated Users to Splunk AppDynamics Roles

From SAML Group Mappings, you can map SAML-authenticated users to one of the Controller roles:

  • Default Role: If a user identity assertion has no SAML group attribute, the SAML default role applies to the authenticated user upon the first login. As you cannot remove the default role, recommendations are to provide minimum permissions. A Splunk AppDynamics administrator can verify and adjust the roles for users manually in Splunk AppDynamics once those users have accounts. 
  • SAML Group: You can map SAML group membership attributes to roles in Splunk AppDynamics. Using this method, each time the user authenticates, the Controller checks the SAML assertion and updates the role assignment as necessary.
  • Internal Group: If a SAML-authenticated user has the same username as a Splunk AppDynamics internal user account and the SAML assertion does not contain mapped SAML group attributes, the Controller gives the user the roles for the internal Splunk AppDynamics account. 

Configure Default Permissions

Instead of mapping SAML attributes to roles, you can also assign users to a default role with the permissions you specify:

  1. To use default permissions, edit the Default Permissions settings in the SAML Group Mappings list.
  2. In the Default Group Mapping dialog, choose the Splunk AppDynamics roles to apply to all authenticated users. 

Verify the SAML Authentication Configuration

Sign in to your Splunk AppDynamics Controller to verify that your configuration of SAML authentication is correct is to log in to your Splunk AppDynamics Controller.

This procedure shows the SAML flow from the service provider (your Controller) and describes the SAML requests and responses. You can also start the SAML flow from the IdP.

When you sign in to your Splunk AppDynamics Controller, the Login dialog for the 3rd-party IdP service appears.

  1. Click Login. The system redirects you to your IdP.
  2. Enter and submit your credentials. The IdP redirects you to your Splunk AppDynamics Controller. 

    If you get a redirect, but the Controller fails to load, it could signify that the request URL from the IdP is different from your internal Controller URL. The most common causes are:

    • Your Controller configuration is set to use HTTPS but the redirect uses HTTP.
    • You changed the default port of the Controller.

    See the suggested resolution in Support Advisory: SAML Authentication Fails after 4.3 Upgrade.

If you set SAML attributes to map to the user account, you can view the user information in Settings Settings > My Preferences.

If you set default permissions so the default role applies to the user, you can view the information in Settings Settings > Administration.