Manage users and groups with SAML in Dynatrace SaaS

Dynatrace SaaS enables authentication through your organization's identity provider (IdP). If you want to use your organization's corporate credentials for authentication in Dynatrace, you can set up SAML to delegate authentication to your IdP.

SAML 2.0 is used for authentication. Based on the domain part of your corporate email address, Dynatrace can determine if SAML was configured for that domain and redirect to your company’s IdP for authentication.

IdP requirements

Your IdP needs to follow some basic SAML specification and security requirements to be compliant with Dynatrace SSO:

  • The entire SAML message must be signed (signing only SAML Assertions is insufficient and will generate a 400 Bad Request response)
  • The SAML protocol version is urn:oasis:names:tc:SAML:2.0:protocol
  • The NameID format is urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
  • IdP response NotBefore and NotOnOrAfter assertion timestamps must consider system clock skew and must be set to at least 1 minute before and 1 minute after the current time (this particularly concerns AD FS default settings)
  • The IdP response status code must be urn:oasis:names:tc:SAML:2.0:status:Success
  • The SignatureMethod algorithm is http://www.w3.org/2001/04/xmldsig-more#rsa-sha256
  • The DigestMethod algorithm is http://www.w3.org/2001/04/xmlenc#sha256
  • No assertion encryption

If your IdP already has an application that uses the previous Dynatrace SSO model (https://proxy.dynatrace.com or https://signin.dynatrace.com), you'll need to create a new application. Keep the old configuration enabled until the new configuration is tested and verified and all of your users have been successfully transitioned.

Dynatrace SSO SP metadata is provided at https://sso.dynatrace.com/sso/metadata. If your IdP requires manual configuration and you don't have any XML parser addons installed in your Chrome browser, we recommend that you view the metadata in Firefox.

Depending on the IdP type, these endpoints need to be configured as follows:

  • https://sso.dynatrace.com:443/saml2/login for Entity ID / Audience Restriction
  • https://sso.dynatrace.com:443/saml2/sp/consumer for Single Sign On URL / Destination URL / Recipient URL
  • https://sso.dynatrace.com:443/saml2/sp/logout for Single Logout Service URL

If your IdP configuration screen contains the option to set SAML bindings for login or logout, set it to urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST.

SAML federated IdP configuration

To set up SAML for your domain

  1. Go to account settings in the user menu and select Single sign-on from the entries on the left.
  2. Create a fallback user account
  3. Verify your ownership of the domain
  4. Configure metadata
  5. Test your configuration

1. Create a fallback user account

When a user signs in, Dynatrace checks the domain part of your corporate email address to determine whether SAML was configured for that domain. If there is a match, the sign-in is redirected to your company’s IdP for authentication. For a fallback, you need an email address that will not be redirected like this.

Important

You need to create a fallback user account so you don't get locked out if you have configuration troubles.

Your fallback account must be a non-federated user account that has the manage users and manage groups permissions and isn't covered by the federated login.

  1. Invite a user with a non-federated email address (an email address with a different domain than the one for which you are setting up SAML).
  2. Specify the manage users and manage groups permissions in the invitation (users can be invited via the User management page).

2. Verify your ownership of the domain

Before you can configure the domain for which you want to set up SAML, you need to prove ownership of the domain.

  1. Select Single sign-on from the menu on the left and then select Add new domain to begin specifying a domain.
    SAML: domain: start
  2. In the Domain box, enter the domain (for example, @mycompanyname.com) for which you want set up SAML.
    SAML: domain: add
  3. Select Copy and add the TXT resource record to your domain’s DNS configuration.
  4. Select Verify so that Dynatrace can verify that the record was added to your domain’s DNS.
    It may take a few minutes for the record to be propagated in the DNS system and the value to become available for Dynatrace to verify.
  5. After successful verification, the Verify button changes to Verified as in the example.
    SAML: domain: verified

3. Configure metadata

After you create a fallback user account and verify your ownership of the domain, you can configure metadata.

  1. Select Add configuration to start configuring metadata.
    SAML: download XML

  2. Select Download XML to download the service provider (SP) metadata displayed in the Service provider SAML 2.0 XML metadata.

    • Alternative: if you prefer, you can select and copy the displayed data from this page instead of downloading a file.
  3. Register the data at your IdP and get the metadata of your IdP in XML format. The activities involved in this step depend upon your IdP's interface and requirements.

    Example IdP-specific instructions for registering the SP data at your IdP and getting the IdP metadata:

    These examples were correct at the time of writing, but Dynatrace has no control over any changes that may be made by your IdP.

  4. Select Upload XML to upload the file containing the metadata of your IdP in XML format.

    • Alternative: if you prefer, you can paste the IdP metadata text directly into the Identity provider SAML 2.0 XML metadata box instead of uploading a file.

    SAML: upload XML

  5. In the Attribute mapping section, specify the following:

    • First name attribute is the attribute that contains the first name of a user.
      For Microsoft Azure, it's http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname
    • Last name attribute is the attribute that contains the last name.
      For Microsoft Azure, it's http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname
    • Security group claim attribute contains the groups/roles of a user from your IdP. This field is needed if you want to use SAML authorization.
      SAML: attribute mapping
  6. Select Validate configuration to verify your settings. You may need to log in to your SSO.
    If validation is successful, Dynatrace will display a confirmation message:
    SAML: validation successful
    Close that message to return to the Add configuration page and then select Continue to display a summary of the validated configuration.
    SAML: configuration summary

  7. Select Single sign-on to enable your configuration.
    Note: Don't log out of Dynatrace yet in case any SSO issues occur.

  8. Select Save to save your configuration.
    SAML: save and enable

4. Test your configuration

To test your configuration

  1. Open a new browser instance and a new incognito window.
  2. Navigate to sso.dynatrace.com and enter your email address at the login page.
  3. Select Next.
    You should be redirected to your company’s IdP.
  4. Provide your domain password.
    After successful authentication, you should redirected to your Dynatrace environment’s home page.

If you experience trouble, use the non-federated user (the fallback user account you created earlier) to change the configuration or disable federation. See Frequently asked questions below for assistance with technical issues.

SAML authorization

You can use SAML authorization to manage permissions in Dynatrace. To do so, you need to map groups from your IdP to groups in Dynatrace.

  1. Select Group management and select a group.

    • We strongly recommend that you create a new group first (select Create new group) to test whether SAML authorization works for that group.
    • Make sure that you have a non-federated user with manage groups permission as discussed earlier.
  2. When you specify a Security group claim name for a group and select Save

    • All existing users from that group will be removed
    • The group becomes a federated group. Assignment of users to that group is then controlled via the Security group claim attribute that you specified on the Single-sign on page.
  3. Expand the Edit pane of a group to set up the mapping.

  4. Specify a value in the field Security group claim name. This is the federated group name that is returned by your IdP and that this Dynatrace group is mapped to.

    • This typically isn't a group display name. It may be, for example, an LDAP ID.
  5. Select Save.
    Note: Don't log out of Dynatrace yet.

  6. Open a new browser instance and a new incognito window and perform the login.

  7. Navigate to account settings (select Account settings in the user menu) and verify that you can still see the User management and Group management tabs on the left.
    If you can't see them, you've lost your Dynatrace admin permissions. Use the non-federated user account to change the configuration if you've run into any issues.

  8. Dynatrace checks the value of the Security group claim attribute of each user following successful login. If a matching Dynatrace group is found, the user is added to the Dynatrace group and inherits all permissions of that group.

Note:

  • When using SAML authorization, it's not required that you invite users to Dynatrace. If a user doesn't yet exist in Dynatrace, but during login one or more matching Dynatrace groups are found (via the security group claim name), the user is created automatically.
  • Upon each login, the Dynatrace group assignment is updated based on the values specified in the Security group claim attribute.

SAML IdP configuration

Follow the examples linked here to configure any of these SAML identity providers (IdPs) to work with Dynatrace SSO.

Frequently asked questions (FAQ)