Skip to main content
BlueXP setup and administration

Federate BlueXP with Active Directory Federation Services (AD FS)

Contributors netapp-tonias
PDFs

Federate your Active Directory Federation Services (AD FS) with BlueXP to enable single sign-on (SSO) for BlueXP. This allows users to log in to BlueXP using their corporate credentials.

Required roles

Organization admin or Federation admin is required to make create and manage federations. Federation viewer can view the Federation page. Learn more about access roles.

Note You can federate with your corporate IdP or with the NetApp Support Site. NetApp recommends choosing one or the other, but not both.

NetApp supports service provider-initiated (SP-initiated) SSO only. First, configure the identity provider to trust BlueXP as a service provider. Then, create a connection in BlueXP using your identity provider's configuration.

You can set up federation with your AD FS server to enable single sign-on (SSO) for BlueXP. The process involves configuring your AD FS to trust BlueXP as a service provider and then creating the connection in BlueXP.

Before you begin

  • An IdP account with administrative privileges is required. Coordinate with your IdP administrator to complete the steps.

  • Identify the domain you want to use for federation. You can use your email domain or a different domain that you own. If you want to use a domain other than your email domain, you must first verify the domain in BlueXP. You can do this by following the steps in the Verify your domain in BlueXP topic.

Steps

  1. In the upper right of the BlueXP console, select The settings icon which displays in the top right of the BlueXP web console. > Identity & Access Management.

  2. Select the Federation tab.

  3. Select Configure new federation.

  4. Enter your domain details:

    1. Choose whether you want to use a verified domain or your email domain. The email domain is the domain associated with the account you are logged in with.

    2. Enter the name of the federation you are configuring.

    3. If you choose a verified domain, select the domain from the list.

  5. Select Next.

  6. For your connection method, choose Protocol and then select Active Directory Federation Services (AD FS).

  7. Select Next.

  8. Create a Relying Party Trust in your AD FS server. You can use PowerShell or manually configure it on your AD FS server. Consult the AD FS documentation for details on how to create a relying party trust.

    1. Create the trust using PowerShell by using following script:

      (new-object Net.WebClient -property @{Encoding = [Text.Encoding]::UTF8}).DownloadString("https://raw.github.com/auth0/AD FS-auth0/master/AD FS.ps1") | iex
AddRelyingParty "urn:auth0:netapp-cloud-account" "https://netapp-cloud-account.auth0.com/login/callback"

    2. Alternatively, you can create the trust manually in the AD FS management console. Use the following BlueXP values when creating the trust:

      • When creating the Relying Trust Identifier, use the YOUR_TENANT value: netapp-cloud-account

      • When you select Enable support for the WS-Federation, use the YOUR_AUTH0_DOMAIN value: netapp-cloud-account.auth0.com

    3. After creating the trust, copy the metadata URL from your AD FS server or download the federation metadata file. You'll need this URL or file to complete the connection in BlueXP.

    NetApp recommends using the metadata URL to let BlueXP automatically retrieve the latest AD FS configuration. If you download the federation metadata file, you will need to update it manually in BlueXP whenever there are changes to your AD FS configuration.

  9. Return to BlueXP, and select Next to create the connection.

  10. Create the connection with AD FS.

    1. Enter the AD FS URL that you copied from your AD FS server in the previous step or upload the federation metadata file that you downloaded from your AD FS server.

  11. Select Create connection. Creating the connection might take a few seconds.

  12. Select Next.

  13. Select Test connection to test your connection. You are directed to a login page for your IdP server. Log in with your IdP credentials to complete the test and return to BlueXP to enable the connection.

  14. Select Next.

  15. On the Enable federation page, review the federation details and then select Enable federation.

  16. Select Finish to complete the process.

After you enable the federation, users can log in to BlueXP using their corporate credentials.