Skip to content

Commit ebfdd35

Browse files
Tim Roesxiaohansong
authored andcommitted
📚 Add documentation for Entra ID (#34569)
1 parent 9789b7f commit ebfdd35

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
sidebar_label: Azure Entra ID
3+
products: cloud-teams
4+
---
5+
6+
import Tabs from "@theme/Tabs";
7+
import TabItem from "@theme/TabItem";
8+
9+
# Setup Single Sign-On via Azure Entra ID
10+
11+
This page guides you through setting up [Single Sign-On](../sso.md) with Airbyte using **Microsoft Azure Entra ID** (formerly known as **Azure Active Directory**).
12+
13+
Airbyte will communicate with your Entra ID using OpenID Connect (OIDC).
14+
15+
## Creating an Entra ID app for Airbyte
16+
17+
:::info
18+
The following steps need to be executed by an administrator of your company's Azure Entra ID account.
19+
:::
20+
21+
You'll require to know your **Company Identifier** to create your application. You receive this
22+
from your contact at Airbyte.
23+
24+
### Create application
25+
26+
You will need to create a new Entra ID application for Airbyte. Log into the [Azure Portal](https://portal.azure.com/) and search for the Entra ID service.
27+
28+
On the Overview of Entra ID press **Add** > **App registration** on the top of the screen.
29+
30+
Specify any name you want (e.g. "Airbyte") and configure a **Redirect URI** of type **Web** with the following value:
31+
32+
```
33+
https://cloud.airbyte.com/auth/realms/<your-company-identifier>/broker/default/endpoint
34+
```
35+
36+
Hit **Register** to create the application.
37+
38+
### Create Client credentials
39+
40+
To create Client credentials for Airbyte to talk to your application head to **Certificates & Secrets** on the detail screen of your application and select the **Client secrets** tab.
41+
42+
Click **New client secret**, specify any Description you want and any Expire date you want.
43+
44+
:::tip
45+
We recommend to chose an expiry date of at least 12 months. You'll need to pass the new Client Secret to use every time the old one expires, to continue being able to log in via Entra ID.
46+
:::
47+
48+
Copy the **Value** (the Client Secret itself) immediately after creation. You won't be able to view this later on again.
49+
50+
### Setup information needed
51+
52+
You'll need to pass your Airbyte contact the following information of the created application.
53+
54+
* **Client Secret**: as copied above
55+
* **Application (client) ID**: You'll find this in the **Essentials** section on the **Overview** page of the application you created
56+
* **OpenID Connect metadata document**: You'll find this in the **Endpoints** panel, that you can open from the top bar on the **Overview** page
57+
58+
Once we've received this information from you, We'll setup SSO for you and let you know once it's ready to be used.

0 commit comments

Comments
 (0)