Steps: Configure SAML SSO Using MS-AD FS 2.0
Explains how to configure
Adaptive Planning
to accept SAML SSO tokens from your instance of Microsoft Active Directory Federation Services 2.0 (AD FS 2.0). Your instance of AD FS is an identity provider and Adaptive Planning
is a service provider. After completing these steps, you’ll have configured an identity provider initiated SSO sign-in from your AD FS 2.0 instance to Adaptive Planning
.Prerequisites
- A machine that:
- Has Windows Server 2008 R2 and AD FS 2.0 installed.
- Has the AD FS 2.0 Rollup 2 hotfix installed and the usage of theRelayStateparameter enabled. See The AD FS 2.0 Rollup 2 Hotfix for more.
- Is included within a domain.
- AnAdaptive Planningaccount with administrative permissions.
- A confirmation email fromAdaptive Planningstating that you've provisioned SAML on yourAdaptive Planninginstance.
- A certification authority verified token signing certificate.
To export the MS AD FS token signing certificate:
- Go toMS AD FS Management Console > Service > Certificates.
- In theCertificateslist, right-clickToken-Signingand clickView Certificate.
- Go to theDetailstab and clickCopy to File.
- When theCertificate Export Wizarddisplays, clickNext.
- SelectDER encoded binary X.509 (.cer), and clickNext.
- Select a directory to save the file and give it a name, and clickNext.
- ClickFinish.
This document uses ADFS_HOST as a placeholder in text to refer to the AD FS website. Replace that with your AD FS 2.0 Web site address.
- The AD FS 2.0 Rollup 2 Hotfix
- If you haven’t already installed the hotfix, go here:After installing the hotfix, enable the usage of the RelayState parameter in the Identity-provider-initiated SSO:
- Open theinetpub\adfs\ls\web.configfile in an editor.
- Locate the section beginning with<microsoft.identityServer.web>
- Add this line to that section:<useRelayStateForIdpInitiatedSignOn enabled="true" />
- Save the file.
Configure Adaptive Planning As a Relying Party
Adaptive Planning
As a Relying PartyA relying party is a web application or web service. It relies on claims extracted from tokens issued by an STS (Security Token Service).
Adaptive Planning
is the relying party and your AD FS 2.0 instance is an STS.- Navigate to the AD FS 2.0 Management console.
- ClickAD FS 2.0and expandTrust Relationships.
- Right-clickRelying Party Trustsand clickAdd Relying Party Trust.
- On theSelect Data Sourcepage, selectEnter data about the relying party manually, and clickNext.
- Specify any appropriate name for the display name. Example: AdaptivePlanning. Enter the notes if any and clickNext.
- SelectAD FS 2.0 Profile.
- Skip the Configure Certificate step.
- Set up theAdaptive PlanningSSO URL, which you’ll get from the SAML Settings page. Example:https://login.adaptiveplanning.com:443/samlsso/VkdHUkVFTkNPQURGUoMzNA==
- On theConfigure Identifierspage, enter the URL from the SAML Settings page inAdaptive Planningas the identifier and clickAdd.
- On the next page, selectPermit all users access to this relying party.SelectDenyif you want to assign this application to specific users later and clickNext.
- On theReady to Add Trustpage, clickNext.
- On theFinishpage, clearOpen the Edit Claims Rules dialog for this relying party trust when the wizard closes, and clickClose.
Configuring Claim Rules
You’ll create some sample claim rules. You can change the claim rules to satisfy your requirements for SAML authentication.
- Sample Claim Rule #1
- In this claim rule, theEmail-Addressvalue of a user is sent as an attribute statement in the SAML response. You can use any LDAP attribute in the SAML token as long as that attribute uniquely identifies each user. Similarly, for the Outgoing Claim Type, select one from the list or type in the name.
- Right-click theAdaptivePlanningentry in theRelying Party Trustslist and selectEdit Claim Rules.
- ClickAdd Rulefrom theIssuance Transform Rulestab.
- SelectSend LDAP Attribute as ClaimsfromClaim Ruletemplate drop-down.
- ClickNext.
- Give the claim a name likeEmail as Claim.
- Set theAttribute Storefield toActive Directory, theLDAP AttributetoEmail-Addresses, and theOutgoing Claim TypetoEmail Address.
- ClickFinish.
- Sample Claim Rule #2
- In this claim rule, we’ll send the email address configured in Claim Rule #1 as theNameIDof the subject.
- ClickAdd Rule.
- SelectTransform an Incoming Claimas the claim rule template to use.
- Give it a name. In this example, we’re usingEmail Address to Name ID.
- The incoming claim type should beE-mail Address(OR it must match the outgoing claim type used in Sample Claim Rule #1).
- SetOutgoing claim typetoName IDandOutgoing name IDformat toEmail.
- SelectPass through all claim values.
- ClickFinish.
This rule will send the E-mail-Address value of a user as the NameID of the subject with the formaturn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress.
Setting Up AD FS as Identity Provider In Adaptive Planning
Adaptive Planning
In this section, you’ll configure your
Adaptive Planning
instance to accept SAML/SSO tokens from your AD FS 2.0 installation. The steps in this section use the sample claim rules described above. If you've created different rules, you will need to alter these instructions accordingly.- Sign in to yourAdaptive Planninginstance as a user with User Administrator permissions.
- Go toAdmin > Manage SAML SSO Settings.
- Enter these settings:
- Identity provider name:Enter your AD FS 2.0 server name here.
- Identity provider Entity ID:Enter the value found on the FS Server AD FS 2.0 Management Console. To find this, right-clickService, clickEdit Federation Services Properties, and copy the value fromFederation Service Identifierfield.
- Identity provider single sign-on URL:Enter the URL from MS AD FS side to log in directly toAdaptive Planningsimilar to:https://ADFS_HOST/adfs/ls.
- Custom log out URL:Optional. Enter a URL to load when the user clicks Logout fromAdaptive Planning. If you don't specify a UR, theAdaptive Planningsign-in page is used.
- Identity Provider Certificate:Select the certificate file included in Prerequisites.
- SAML user ID type:Select the user federation ID. If you set up your claim rule to use the user email address and that address is the same as the login field on the user profile, selectUser'sforAdaptive Planninguser nameSAML User ID.
- SAML user ID location: If you only configured Sample Claim Rule #1 in the claim rules of the relying party, then select User ID in Attribute. If you configured Sample Claim Rule #2, then selectUser IDforNameID of Subject.
- SAML attributeandSAML NameID format:You only need to enter one of these:
- If you only configured Sample Claim Rule #1, fill in theSAML attributefield with the outgoing claim type from Sample Claim Rule #1. Leave the SAML NameID format field blank.
- If you configured both sample claim rules, skip theSAML attributefield and fill in theSAML NameIDfield. Use the outgoing name ID format from Sample Claim Rule #2 (Email).
- Enable SAML: Select Not Enabled (this is the default value). After testing the configuration, return to this page and enable SAML for other users.
- ClickSave.TheAdaptive PlanningAdmin Overview page will load.
- Look forat the bottom of the page, and copy the entire string value. Save this value as you’ll need it in the next section. Example:Adaptive PlanningSSO URL
https://login.adaptiveplanning.com:443/samlsso/VkdHUKVFTkNPQURGU0MzNA--
Complete the Configuration of the AD FS Relying Party
You’ll complete the AD FS relying party setup, which you started in Configuring Adaptive Planning as a Relying Party.
- Navigate back to your AD FS 2.0 administration console.
- Right-clickAdaptivePlanningin theRelying Party Trustslist and selectProperties.
- Click theEndpointstab and clickAdd.
- SetEndpoint TypetoSAML Assertion Consumer.
- SetBindingtoPOST.
- Paste the value of theAdaptive PlanningSSO URL, which you copied in Step 6 of Setting up MS AD FS as Identity Provider in Adaptive Planning, into theURLfield.
- ClickOKand clickApplyin the properties dialog.
Test the Setup
Test the SAML - SSO sign in from AD FS 2.0 into
Adaptive Planning
.- Select a user on the AD FS and onAdaptive Planning. TheAdaptive Planninguser must have SAML Admin permission.
- Enter the email address (or the LDAP attribute selected in Claim Rule #1) in AD FS for that user.
- FromAdaptive Planning, enter the email address in theSAML Federation IDfield for the user on theAdministration > Userspage and clickSubmit.
- Log that AD FS user into a computer that is part of the Active Directory domain.
- Within a web browser on that computer, go tohttps://login.adaptiveplanning.com/appIf your instance uses non-US based, regional authentication, then your authorization URLs and API endpoints vary based on your region. See Reference: Regional Authentication URLs.
- If you configured everything correctly, you're redirected to theAdaptive Planningwelcome page. Enter the username but leave the password field blank on the sign-in page. ClickSubmit.
After successfully testing your setup, enable SAML SSO for your users. See Enabling SAML SSO for all Users in Adaptive Planning.
SSO Into Excel Interface for Planning and OfficeConnect
After you've successfully configured and tested SAML SSO,
Excel Interface for Planning
and OfficeConnect
users can
sign in using only their usernames. They can leave the password field blank.