Skip to main content
info
This documentation is for version v2.6 of the product.
For the latest version(v2.7) documentation click here
Version: v2.6 print this page

Microsoft Entra ID SSO

Amazon Cognito integrates with Microsoft Entra ID to enable existing Entra ID users to sign-on to Amorphic Data Cloud. This section explains how to register and set up your application with Microsoft Entra ID as an identity provider.

What is Single Sign-On?

Single sign-on (SSO) is an authentication method that enables users to securely authenticate with multiple applications and websites by using just one set of credentials. SSO works based upon a trust relationship set up between an application, known as the service provider, like Amorphic Data Cloud and an identity provider, like Microsoft Entra ID. This trust relationship is often based upon a certificate that is exchanged between the identity provider and the service provider. This certificate can be used to sign identity information that is being sent from the identity provider to the service provider so that the service provider knows it is coming from a trusted source.

Amorphic username convention

Due to the variety of systems Amorphic integrates with, Amorphic requires strict rules to be enforced for its usernames. Failure to follow the required rules may lead to Amorphic users not being able to login as intended. These rules required for Amorphic are conventional rules required for Entra ID integration from other systems, and follow best practices.

The requirement for the usernames are as follows:

  • The usernames must be unique for different users
  • Usernames are integrated with access to datasets and resources, and as such cannot change
  • Should only start with a letter in lowercase, cannot be started with a number
  • Should be only alphanumeric, no special characters are permitted
  • Should use only lowercase alphabets
  • Should have a minimum of 3 characters and should not exceed 20 characters
info

It should be noted that any and all transformations used to convert the username in the SSO provider to the Amorphic username should produce a username compliant with the Amorphic username convention specified above. For eg; if you have John_Doe@email.com and the transformation gives it as John or John_Doe, it is not compliant as it violates the first and last rules, and it would be best to be something like johndoe. If you have such IDs, it is recommended to create new field with an Amorphic compliant username format, and to use that as an Amoprhic username.

Pre-requisites for Microsoft Entra ID Identity Provider

Before we proceed with the Microsoft Entra ID IDP setup, we need the following pre-requisites:

  1. Azure account - https://portal.azure.com/
  2. Amorphic Application Deployed with Identity Provider option enabled

Steps to register Amorphic app with Microsoft Entra ID

  • Create a Non-Gallery Enterprise Application with SSO enabled under Microsoft Entra ID Service
  • Get App Federation Metadata Url & Login URL
  1. Login to Azure portal using this link.

  2. Search for Microsoft Entra ID as shown in below image and open it.

image

  1. Select Enterprise applications on the left menu panel of portal & Select New Application as shown in below image:

image

  1. Click on Create your own application as shown in below image:

image

  1. Enter a custom name for your application & finally click on Create. Make sure to select Integrate any other application you don't find in the gallery (Non-gallery) option as shown below:

image

Basic SAML configuration

  1. On the newly created Enterprise application page, select Single sign-on option on the left menu panel and select Set up Single Sign-On as shown below:

image

  1. choose SAML as the single sign-on method

image

  1. edit Basic SAML Configuration section and add Identifier Entity Id and Reply URL

image

  • Format of Identifier Entity Id: urn:amazon:cognito:sp:<cognito-userpool-id>
  • Format of Reply URL: https://<cognito-domain>/saml2/idpresponse

Cloudwick Support Team will provide both cognito-userpool-id and cognito-domain values.

User Attributes and Claims

In User attributes and claims section, 3 attributes are important

  • email
  • name
  • username
  1. edit attributes and claims section

image

  1. Click on Add new claim and add values as shown in the image and save them after changes

image

image

Use Transformation to extract mail prefix and alphabets from email attribute.

info

The following is an example for reference on how to do so. You should ensure that appropriate transformations should be used so as to conform to the Amorphic username convention.

image

info

It is very important to note that the mappings, once created and users are logged in, should not be modified later on as that may introduce issues downstream.

  1. After successfully updated, the attribute page shows all three newly added attributes as shown below:

image

Get App Federation Metadata Url & Login URL

  1. Copy App Federation Metadata Url and Login URL as shown below

image

Update Amorphic with credentials

  1. In Amorphic CMP (customer management portal), select IDP provider as SAML and update the values.
  • IDP Server URL in cmp corresponds to Login URL retrieved from Entra ID
  • IDP Metadata URL corresponds to App Federation Metadata Url from Entra ID

Once the values are added, click on Update IDP Details. This will take around 45-60 mins to get reflected in the login page.

image

Frequently asked questions (FAQ)

1. Why is attribute mapping required?

a. When integrating with Microsoft Entra ID and cognito, Amorphic requires attributes such as username, name and email from Azure to successfully register user.

2. To which value should the email be mapped?

a. In Azure email attribute need to be mapped to userprincipalname value.

3. To which value should the username be mapped?

a. In Azure username attribute need to be mapped to userprincipalname value along with transformation to get a unique value. The transformations applied are ExtractMailPrefix and ExtractAlpha

4. To which value should the name be mapped?

a. In Azure name attribute need to be mapped to displayname value.

5. What happens if any configuration changes at Identity Provider end?

a. When Identity Provider configuration like Certificate, etc changes, Cloudwick support team must re-import the saml metadata file in AWS Cognito Console.