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 notice and limitations
SAML 2.0 is used for authentication and optionally for authorization. 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.
Be aware that the SAML configuration affects all other accounts and users that share the same domain name.
Mobile user access
SAML is mainly a protocol for Single-Sign-On (SSO) and Identity Federation, and does not provide features for regular user and permission synchronization.
Although we support on-the-fly creation of federated users for the first time they have authenticated to Dynatrace over your company's IdP, and federated user attributes update on every sign-on, additional actions are required to cover functionalities that are not within the scope of SAML. Specifically, if a federated user has been removed or deactivated in the customer Active Directory but not in Dynatrace, and if that user issued Oauth2 tokens (for access to the Dynatrace Mobile App) before losing access to Dynatrace, those tokens can remain valid for up to 30 days.
In order to remove all access, you need to remove users manually (or you can harness SCIM for automatic user management).
IdP requirements and specification
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 generates a
400 Bad Requestresponse).
- The SAML protocol version is
- IdP response
NotOnOrAfterassertion 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
- No assertion encryption.
Just-in-Timeprovisioning is supported.
- Session timeout is not configurable and it is
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 extensions 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/loginfor Entity ID / Audience Restriction
https://sso.dynatrace.com:443/saml2/sp/consumerfor Single Sign On URL / Destination URL / Recipient URL
https://sso.dynatrace.com:443/saml2/sp/logoutfor Single Logout Service URL
If your IdP configuration screen contains the option to set SAML bindings for sign-in or sign-out, set it to
SAML federated IdP configuration
To set up SAML for your domain
- Create a fallback user account
- Verify your ownership of the domain
- Configure metadata
- 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's a match, the sign-in is redirected to your company’s IdP for authentication. For a fallback, you need an email address that won't be redirected like this.
You need to create a fallback user account so you won't be 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 sign-in.
- Go to Identity management > User management and select Invite user to invite a user with a non-federated email address (an email address with a different domain from the one for which you are setting up SAML).
- Specify the Manage users and Manage groups permissions in the invitation.
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.
- From the User menu, select Account settings.
- Select Identity management > Single sign-on.
- In the Verify domain section, enter the domain (for example,
mycompanyname.com) for which you want to set up SAML.Multiple domains
If users in your organization use more than one domain to sign in (for example,
@uk.mycompanyname.com), you can add additional domains in additional rows and start verifying them all in parallel. Enter each domain in a different row.
- For each domain you are verifying, select Copy and add the copied TXT resource record to your domain’s DNS configuration.
- For each domain you are verifying, select Verify so that Dynatrace can verify that the record was added to your domain’s DNS.
It typically takes a few minutes for a record to propagate through the DNS system and the value to become available for Dynatrace to verify. In some cases, it may take up to 24 hours.
- Each verified domain is added to the Verified domains list.
3. Configure metadata
Select Add to start configuring metadata.
Select Download XML to download the service provider (SP) metadata displayed in Service provider SAML 2.0 XML metadata.
- Alternative: If you prefer, you can select the data in the Service provider SAML 2.0 XML metadata text box and copy it to your clipboard instead of downloading a file.
Register the data at your IdP and get the metadata of your IdP in XML format. The activities involved in this step depend on your IdP's interface and requirements.
X509Certificateappended to metadata needs to be signed using one of the following algorithms:
Dynatrace supports all IdPs that support the SAML 2.0 standard. For frequently used IdPs, we have 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 changes that may be made by your IdP.
Select Choose file 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.
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
- Last name attribute is the attribute that contains the last name.
For Microsoft Azure, it's
- 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.
- First name attribute is the attribute that contains the first name of a user.
Select Validate configuration to verify your settings.
Important: Configuration validation is based on sign-in to Dynatrace via SSO. Validation can succeed only if:
- You have privileges to sign in to Dynatrace.
- You sign in to federation and are redirected to Dynatrace with the proper SAML message.
- If validation is successful, Dynatrace displays a confirmation message. Close the message to return to Add configuration and then select Continue to display a summary of the validated configuration.
- If there's an error in the Results list, select Edit configuration to fix it before continuing.
On Enable SSO, select Enable if you are ready to activate your configuration.
Note: Don't sign out of Dynatrace yet in case any SSO issues occur.
Select Save & continue to save your configuration.Caution
These configuration changes affect accounts and users that share the same domain name. For example:
- If you've already configured SAML for a trial account using domain "example.com" and now you are configuring a production account that also uses domain "example.com". In this case, the changes you submit now will apply to both accounts (you will overwrite the SAML configuration for the trial account when you save changes for the production account).
- If you have users on another account whose email addresses also use the "example.com" domain. In this case, those users (all users whose email address ends with "example.com") will have to sign in using the new IdP configuration.
4. Test your configuration
To test your configuration
- Open a new browser instance and a new incognito window.
- Go to sso.dynatrace.com and enter your email address.
- Select Next.
You should be redirected to your company’s IdP.
- Provide your domain password.
After successful authentication, you should be 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 sign in and change the configuration or disable federation.
- See Frequently asked questions below for answers to common questions.
To use SAML authorization to manage permissions in Dynatrace, you need to specify the security group claim attribute in the attribute mapping configuration that contains the groups/roles of a user from your IdP, and then map groups from your IdP to groups in Dynatrace.
In Dynatrace, all user group permissions are joined together. There are four group types:
DCS. It is the Account Manager's responsibility to decide if and how user permissions are isolated.
- From the User menu, select Account settings.
- Select Identity management > Group management and add a new group or find an existing group you want to map. You can filter the list by name and permissions.
- We strongly recommend that you first create a new group (select Add group) to test whether SAML authorization works for that group.
- Switching a
SAMLremoves all user assignments to that group.
- Make sure you have a non-federated user with manage groups permission as discussed earlier.
- Expand the Edit pane of the group to set up a mapping.
- Group name—Make sure it matches the group you intend to edit.
- Security group claims—A list of one or more federated group names returned by your IdP and mapped to this Dynatrace group.
Select Add claim if you need to add a claim.
This typically isn't a group display name. It can be, for example, an LDAP ID.
When you specify security group claim for a group and select Save:
- All existing users from that group are 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 Single-sign on.
- Account permissions
Account-related permissions for members of this group.
- Environment permissions
Environment-related permissions for members of this group.
- Management zone permissions
Management zone—related permissions for members of this group.
- Select Save.
Note: Don't sign out of Dynatrace yet.
- Open a new browser instance and a new incognito window and sign in.
- Go to account settings (select Account settings in the user menu) and verify that you can still see Identity management > User management and Identity management > Group management.
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.
- Dynatrace checks Security group claims of each user following successful sign-in. If a matching Dynatrace group is found, the user is added to the Dynatrace group and inherits all permissions of that group.
- When using SAML authorization, it isn't required that you invite users to Dynatrace. If a user doesn't yet exist in Dynatrace, but during sign-in one or more matching Dynatrace groups are found (via the security group claim name), the user is created automatically.
- Upon each sign-in, the Dynatrace group assignment is updated based on the values specified by the Security group claim attribute.
Frequently asked questions (FAQ)
If you are using PingFederate as an IdP and you get a Missing Destination Attribute value error
- Go to PingFederate and select Identity Provider in the left sidebar.
- Select the Signature Policy tab.
- Clear the ALWAYS SIGN ASSERTION checkbox as in the following example.
NameIdFormat must be
Whole messages need to be signed, including sign-out requests and responses. It isn't sufficient to sign just the assertion part.
Upon sign-out, a global sign-out is triggered, including for your IdP, which then cascades to other services. Otherwise, you would be signed out from Dynatrace, but it would be sufficient to just enter your email to reauthenticate.
If you want to disable it (not a good idea from a security standpoint), edit your metadata, remove all
SingleLogoutService tags, and upload the updated metadata.
You need two issuance transform rules, in this order:
- The first one uses the
Send LDAP Attributes as Claimsrule template and creates an outgoing claim type named
E-Mail Addressfrom an LDAP attribute in your attribute store containing the Dynatrace username (the user’s domain email address).
- The second one uses the
Transform an Incoming Claimrule template and creates an outgoing claim type
Name IDand outgoing name ID format
Pass through all claim valuesoption enabled.
If, after you authenticate with your IdP, you are redirected to a Dynatrace page such as We’ve run into technical difficulties… or 400 Bad Request, it's likely that there's a problem with the configuration.
The most common causes of this are:
- Your IdP doesn’t accept an
authNrequest using our
NameIdformat and returns an error response with the status code
urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress. You might also need a rule to create a
NameIdusing our format.
- You're using a
<saml:Attribute/>to return the Dynatrace username but the attribute wasn't recognized by Dynatrace; alternatively, we couldn't find it using
NameIDas we didn't recognize its format. See the previous question (
What claim rules do I need in AD FS on the Dynatrace relying party?) for the proper format.
- Dynatrace didn't trust your IdP SAML signing certificate. The IdP SAML metadata you uploaded did not contain a certificate for signing that matches the certificate in the assertion sent by your IdP. Verify that the certificate is in the metadata XML file that was uploaded to Dynatrace. If you're using a URL to upload the metadata, look at the contents generated by the URL. In some organizations, the SAML signing certificate must be requested separately and manually inserted into the metadata by saving the URL contents to a file, adding the signing certificate to the file, and then uploading the file to us.
- The response from the IdP isn't fully signed (assertion signature might be present, but it isn't sufficient).
- Your IdP doesn't accept some SAML objects or attributes that the SAML 2.0 specification describes as optional. Please contact Dynatrace Support.
Yes, Dynatrace supports JIT, and federated users are created or updated on the fly based on SAML attributes following successful authentication.
No, it can be removed after Dynatrace has successfully validated ownership of the domain.
Yes, but you need to perform domain verification and create a configuration for each domain separately. Each domain configuration can use the same IdP metadata and settings.
Yes, customer IdP metadata can contain multiple signing certificates. Dynatrace SSO validates that SAML messages from the customer IdP are signed by one of them.
No, a full DN contains commas, and this is recognized as independent group names. The IdP should send the group name or group ID.
Yes, both IdP-initiated sign-in and
RelayState are supported.
Yes. When a Dynatrace environment URL is sent in the
RelayState parameter, the user is redirected to the specified URL upon signing in. When the
RelayState value is missing, the user is redirected to the last accessed Dynatrace tenant or account page.
Depending on the IdP, setting
RelayState in an IdP SAML configuration usually affects all IdP users. Dynatrace SSO does not support a default destination per user.
Yes. If the value of the Group SAML attribute contains a comma-separated list of groups, the value will be split by comma and interpreted as a list of groups.
Yes. For example, if your IdP returned groups as the LDAP path:
Dynatrace would interpret this as a comma-separated list of four groups:
In group mapping, you should use one of these values.
If your security policy requires emergency access to Dynatrace in case of problems with your IdP, we recommend that you invite a non-federated user to the environment with Account manager permissions and use that as your Break Glass account.
- If this is not an option, you can configure an additional federated domain to a different IdP and use it for backup sign-on in case of problems with your regular IdP.
- Configuring multi-factor authentication (MFA) is not supported by Dynatrace. You can configure authentication and MFA through your organization's IDP.
Configuring multi-factor authentication (MFA) is not supported by Dynatrace. You can configure authentication and MFA through your organization's IDP.
SAML metadata can contain more than one certificate, not all of which need to be valid. This is very useful when you want to rotate your certificates because the current one is going to expire.
To switch certificates
- Create a new certificate that meets our requirements.
Don't change it on your IdP side yet! If you do so, you will cut access to the Dynatrace environment.
- Append the new certificate to your metadata in Dynatrace.
- If your IdP allows you to include more than one certificate, you can add the certificate in the IdP and then upload to Dynatrace the entire updated metadata generated by your IdP.
- Otherwise, copy the full
<KeyDescriptor use="signing"> (...) </KeyDescriptor>element in metadata, paste it under the current one, and, in the copy, replace the certificate value with your new certificate value, which is located between the
</ds:X509Certificate>tags in the
<KeyDescriptor>element you just pasted.
- Update the metadata on the Dynatrace side only.
- Test your configuration.
- If the verification process completes without issues, you can update the certificate on your IdP side.
- Run the configuration test again.
- optional To doublecheck your configuration, sign out and in again.
If you have problems, you can switch back to the older certificate in your IdP and try again.
- optional Remove the older certificate from your IdP metadata in Dynatrace.