# Entra ID

This page provides step-by-step instructions for setting up Entra ID as your identity provider for Single Sign-On (SSO) in BirdCRM using SAML.&#x20;

**Configuration overview:**

[Step 1: Start Entra ID](#entra-id-steps) – Begin by setting up specific configurations within your Entra ID account.

[Step 2: BirdCRM Steps](#birdcrm-steps) – Follow the required steps within BirdCRM to integrate with Entra ID.

[Step 3: Finalize Entra ID](#finalize-entra-id-steps) – Complete the configuration by finalizing settings in Entra ID.

### Entra ID Steps

1. Navigate to Enterprise Applications in Entra ID and click on New application.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2F46UMbFV26A6ZGVCn58fM%2Funnamed.png?alt=media&#x26;token=092acd55-5b49-40af-abfc-a1edb49e4a4b" alt=""><figcaption></figcaption></figure>

2. Click on **Create your own application**.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2FI9TSNwRLVerishE8ISA9%2Funnamed-1.png?alt=media&#x26;token=1614bd09-08e8-486b-9258-dbcf493dd05b" alt="" width="563"><figcaption></figcaption></figure>

3. Give the application a name such as BirdCRM and select Integrate any other application you don’t find in the gallery (Non-gallery) and click **Create**.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2FzmMFnqegBhwVjeqzv8PQ%2Funnamed-2.png?alt=media&#x26;token=fc86f6d5-b1df-45f9-83ae-e20cd4e339aa" alt="" width="563"><figcaption></figcaption></figure>

4. Click on '**2 Setup single sign on**'

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2F1qnBySJzFWfUcKPOigdj%2Funnamed.png?alt=media&#x26;token=e64145fa-d694-44e4-9866-1f2865c87d18" alt=""><figcaption></figcaption></figure>

5. Click on **SAML**.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2F1QMNSWioH75BCj8fkdZ9%2Funnamed-1.png?alt=media&#x26;token=8bd0081d-2f64-44c1-8b64-19dbd66cfe11" alt=""><figcaption></figcaption></figure>

6. Scroll down to section 3 '**SAML Certificates**' and click copy on the **App Federation Metadata Url**. You will need this URL to setup SAML in BirdCRM in the next section.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2FcH51b2dOfBy2cqaGggjk%2Funnamed-2.png?alt=media&#x26;token=9a451b68-54a0-4d50-86f3-0927cced1b3c" alt=""><figcaption></figcaption></figure>

### BirdCRM Steps

1. Navigate to the **Access Settings** in BirdCRM located [here](https://app.bird.com/settings/security/access-settings) and click on **Set up SSO** and select **SAML**.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2FuCeFaiDpYf8Is8vyir6y%2Funnamed-3.png?alt=media&#x26;token=5b83e596-106a-47bb-a701-28ec69787e94" alt=""><figcaption></figcaption></figure>

2. Enter a name for your SSO connection in BirdCRM and paste the metadata URL in the File URL text box and click Confirm.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2FscdMGr2QtCY6no6lirHa%2Funnamed-4.png?alt=media&#x26;token=cd2393d8-c3e7-431b-bd5f-abab63c1c3e2" alt="" width="375"><figcaption></figcaption></figure>

{% hint style="success" %}
Your SAML integration is now saved.&#x20;
{% endhint %}

*The next steps are to add one or more domains that you can login with and also retrieve the required values to complete the Entra ID settings. The order is not important but these instructions will perform the domain validation first and then retrieve the values to use in Entra ID.*

3. To start with, select your **SSO integration** and click on **View**.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2F4s3ZDDYzD8I6WJ9OlWrE%2Funnamed-5.png?alt=media&#x26;token=b93e0887-68ec-4855-912f-0860c3a6d6e5" alt=""><figcaption></figcaption></figure>

4. Now we will validate your domain(s) that you will login from Entra ID with. First click on the **Domain Validation** button available when viewing your SSO integration

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2F46f4BlgKIaFHskQ4hdn2%2Funnamed-6.png?alt=media&#x26;token=3b565973-00e9-4d63-b468-89b221f927eb" alt="" width="563"><figcaption></figcaption></figure>

5. Enter your company domain name that you login with (e.g. companyname.com) and click **Create**.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2FqjStCshoRpykk59SMGHn%2Funnamed-7.png?alt=media&#x26;token=c90dcc5a-9fe4-449f-8d83-66674db13769" alt="" width="563"><figcaption></figcaption></figure>

6. You will then be presented with a unique string under the **Challenge** column that needs to be placed as a TXT record in your domain. If you are unsure how to add a TXT record please consult with your DNS provider.
7. Once you have added the TXT record to verify your domain, you can select **Verify**.
8. If the TXT record was added correctly it will then show the **Status of Verified**.
9. Now we can get the final details to complete the Entra ID configuration. Click on **Details** in the SSO configuration.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2F9PxaFLYOaQq7PKSehc21%2Funnamed-8.png?alt=media&#x26;token=6af4ade1-345f-43b1-a3d2-57e7a6cec1e4" alt="" width="375"><figcaption></figcaption></figure>

10. From this screen you will need to take a copy of the **Single Sign On URL** and the **Audience URI** fields which will be used to complete your Entra ID configuration.

### Finalize Entra ID Steps

1. From the Single Sign-On section of your BirdCRM application in Entra ID, click on the Edit button under the Basic SAML Configuration box.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2Fw5MJiC3OXaO9T0QtssXD%2Funnamed.png?alt=media&#x26;token=1a14e057-e82d-4e9f-ad82-12f1cfc0622e" alt=""><figcaption></figcaption></figure>

2. Fill out the Audience URI you copied from BirdCRM in the **Identifier (Entity ID)** field and the **Single Sign On URL** you copied from BirdCRM in the **Reply URL** field. You can leave the other fields blank. Click on **Save**.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2FeDzBOHhBwzihmNBv6zmr%2Funnamed-1.png?alt=media&#x26;token=563af2f8-6d8a-404e-b059-1ba7df9cbb55" alt=""><figcaption></figcaption></figure>

3. Click on the **Edit** button under **Attributes & Claims**.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2FrYj6VJA8xo547jyvZ4Du%2Funnamed-2.png?alt=media&#x26;token=e505938c-c354-4e6b-9491-03ef8f9077d9" alt=""><figcaption></figcaption></figure>

4. Click on **Add new claim** and enter email as the **Name** and user.userprincipalname as the **Source attribute** and click **Save**.

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2FjnZKqC4F34Zb05NlMapV%2Funnamed-3.png?alt=media&#x26;token=17c73a21-4d50-4199-9207-8a430ea67c71" alt=""><figcaption></figcaption></figure>

5. Repeat and **add another claim** with the Name name and the Source attribute user.givenname.
6. Remove any other Additional claims by clicking on the three dots menu for each claim and clicking Delete. Once you have removed the extra default claims, your **Attributes & Claims** section should look like this. *Please note that name can be set to another value if necessary but it must have a value associated with it for each user.*

<figure><img src="https://3861485111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FU9kiDiTGVD8kkbnKKyEn%2Fuploads%2FxUdwb1k319qvHAdt89xX%2Funnamed-4.png?alt=media&#x26;token=ba9d0cbd-8f7d-4a13-81c3-1cd0aec31ee1" alt=""><figcaption></figcaption></figure>

7. You have now completed the Entra ID SSO setup. Make sure that you assign the application to your users and groups as required.
