Skip to content

Commit 1ad5c45

Browse files
cickudcpena
authored andcommitted
[IAM] More details with Entra + SCIM (#23380)
* Update Entra guide * Update entra.mdx * Update index.mdx * Update entra.mdx * Update entra.mdx * Update index.mdx * Update okta.mdx * Update index.mdx * Update index.mdx * Update entra.mdx * Update index.mdx * Update entra.mdx * Update entra.mdx * Changes to align with style guide * Minor updates to align with style guide --------- Co-authored-by: Denise Peña <[email protected]>
1 parent 8cfa0db commit 1ad5c45

File tree

3 files changed

+42
-25
lines changed

3 files changed

+42
-25
lines changed

src/content/docs/fundamentals/account/account-security/scim-setup/entra.mdx

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,43 @@ import { Render } from "~/components";
99

1010
<Render file="idp-group-deprecation" />
1111

12+
Once you have [gathered the required data](/fundamentals/account/account-security/scim-setup/#gather-the-required-data), the following steps will be required to finish the provisioning with Entra.
13+
1214
## Set up the Enterprise application
1315

14-
1. Go to your Microsoft Entra ID instance and select **Enterprise Applications**.
15-
2. Select **Create your own application** and name your application.
16-
3. Select **Integrate any other application you do not find in the gallery (Non-gallery)**.
17-
4. Select **Create**.
16+
1. Go to the Entra admin center and select **Applications** > **Enterprise Applications**.
17+
2. In the Microsoft Entra Gallery, select **New application** > **Create your own application**, then choose a name.
18+
3. Select **Integrate any other application you don't find in the gallery (Non-gallery)**.
19+
4. **Create** an application.
1820

1921
## Provision the Enterprise application
2022

21-
1. Under **Manage** on the sidebar menu, select **Provisioning**.
22-
2. Select **Automatic** on the dropdown menu for the Provisioning Mode.
23-
3. Enter your API token value and the tenant URL: `https://api.cloudflare.com/client/v4/accounts/<your_account_ID>/scim/v2`.
24-
4. Select **Test Connection**, then select **Save**.
23+
1. Inside the newly created application under **Manage** from the sidebar menu, select **Provisioning**.
24+
2. Select **New configuration** and enter the **Tenant URL**: `https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/scim/v2`. Replace `<ACCOUNT_ID>` with your own account ID.
25+
3. Paste the SCIM provisioning API token value as **Secret token**.
26+
4. Select **Test Connection** then **Save** the configuration.
2527

26-
## Configure user & group sync in Microsoft Entra ID application
28+
## Configure user and group synchronization
2729

28-
1. Once the SCIM application is created, [assign users and groups to the application](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/assign-user-or-group-access-portal?pivots=portal).
29-
2. To begin syncing your Users & Groups into Cloudflare, navigate back to **Provisioning**, and under **Provisioning Status**, check *On*, then select **Save**.
30+
1. Navigate to the newly created application under **Manage** from the sidebar menu, select **Users and groups**.
31+
2. [Assign users and groups to the application](https://learn.microsoft.com/entra/identity/enterprise-apps/assign-user-or-group-access-portal).
32+
3. After the users are assigned, navigate to **Provisioning** on the sidebar menu and select **Start Provisioning**.
3033

3134
:::note
32-
To successfully provision with Microsoft Entra ID, the `user principal name` and `email` fields must match. These values are case-sensitive.
35+
To successfully synchronize the group details into Cloudflare the `User Principal Name` (of `Identity`) and `Email` (of `Contact Information`) fields of each user must be identical. Values are case-sensitive, and the User Principal Name can only contain alphanumeric characters. Learn more about [how to create, invite, and delete users](https://learn.microsoft.com/entra/fundamentals/how-to-create-delete-users).
3336
:::
3437

35-
3. To validate which users and groups were synchronized, select **Provisioning logs** in Microsoft Entra. You can also check the Cloudflare dashboard Audit Logs by navigating to **Manage Account** > **Audit Log**.
36-
4. To grant permissions to Users & Groups in Cloudflare, refer to the Permission Policies guide.
38+
4. To validate which users and groups have been synchronized, navigate to **Provisioning logs** on the sidebar menu. You can also [review the Cloudflare Audit Logs](/fundamentals/account/account-security/review-audit-logs/).
39+
40+
:::caution[Read-only group]
41+
If the Entra group shares the same name of an existing Cloudflare user group, the Cloudflare user group will become read-only after the provisioning.
42+
:::
3743

44+
5. To grant permissions to users and groups at Cloudflare, refer to [Roles](/fundamentals/manage-members/roles/) and [Policies](/fundamentals/manage-members/policies/).
3845

3946
## (Optional) Automate Cloudflare's SCIM integration
4047

41-
Cloudflare's SCIM integration requires one external application per account. Customers with many accounts may want to automate part of the setup to save time and reduce the amount of time spent in the Entra administrative UI.
48+
Cloudflare's SCIM integration requires one external application per account. Customers with multiple accounts may want to automate part of the setup to save time and reduce the amount of time spent in the Entra administrative UI.
4249

4350
The initial setup of creating the non-gallery applications and adding the provisioning URL and API key are scriptable via API, but the rest of the setup is dependent on your specific need and IDP configuration.
4451

src/content/docs/fundamentals/account/account-security/scim-setup/index.mdx

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,21 @@ title: SCIM provisioning
44

55
---
66

7-
Cloudflare supports bulk provisioning of users into the Cloudflare dashboard by using the System for Cross-domain Identity Management (SCIM) protocol. This allows you to connect your external identity provider (IdP) to Cloudflare and quickly onboard and manage users and their permissions. Cloudflare supports SCIM onboarding with Okta and Microsoft Entra.
7+
Cloudflare supports bulk provisioning of users into the Cloudflare dashboard by using the System for Cross-domain Identity Management (SCIM) protocol. This allows you to connect an external identity provider (IdP) to Cloudflare, quickly onboard and manage user permissions. Currently, SCIM provisioning has been integrated with Okta and Microsoft Entra.
88

99
:::note
10-
This section covers SCIM provisioning for the Cloudflare dashboard only. If you need to provision SCIM for Cloudflare Zero Trust, refer to [Zero Trust SCIM provisioning](/cloudflare-one/identity/users/scim/).
10+
This section covers SCIM provisioning for the Cloudflare dashboard. If you need to provision SCIM for Cloudflare Zero Trust, refer to [Zero Trust SCIM provisioning](/cloudflare-one/identity/users/scim/).
1111
:::
1212

13+
## Objectives
14+
15+
Once the SCIM provisioning is enabled:
16+
17+
- A Cloudflare account can receive user group provisioning from the identity provider.
18+
- Members of each user group can be assigned one or more [policies](/fundamentals/manage-members/policies/). Each policy defines one or more [roles](https://developers.cloudflare.com/fundamentals/manage-members/roles/) applied to all group members thereof.
19+
- Members can belong to multiple user groups, and each group can also be configured with different policies.
20+
- Policies provisioned via SCIM can coexist with policies configured via the [traditional setup](/fundamentals/manage-members/manage/#edit-member-permissions).
21+
1322
## Expected behaviors
1423

1524
Expectations for user lifecycle management with SCIM:
@@ -28,19 +37,18 @@ Expectations for user lifecycle management with SCIM:
2837

2938
## Prerequisites
3039

31-
- Cloudflare provisioning with SCIM is only available to Enterprise customers using Okta or Microsoft Entra.
32-
- You must be a [Super Administrator](/fundamentals/manage-members/roles/) on the account.
33-
- In your identity provider, you must have the ability to create applications and groups.
40+
- Cloudflare dashboard SCIM provisioning is only available to Enterprise customers using Okta or Microsoft Entra.
41+
- You must be a Super Administrator for the initial setup.
42+
- In the identity provider, you must have the ability to create applications and groups.
3443

3544
---
3645
## Gather the required data
3746

3847
To start, you will need to collect a couple of pieces of data from Cloudflare and set these aside for later use.
3948

40-
### Get your Account ID
49+
### Get the Account ID
4150

42-
1. In the [Cloudflare dashboard](https://dash.cloudflare.com/), go to the Cloudflare account that you want to configure for SCIM provisioning.
43-
2. Copy your account ID from the account home page.
51+
The account ID can be found via dashboard or API. For more information, refer to [Find account and zone IDs](/fundamentals/account/find-account-and-zone-ids/).
4452

4553
### Create an API token
4654

@@ -52,7 +60,7 @@ To start, you will need to collect a couple of pieces of data from Cloudflare an
5260

5361
:::note
5462

55-
Cloudflare recommends using Account Owned API Tokens for SCIM Provisioning. Using user-specific API tokens, while supported, will lead to a broken SCIM connection in the event that the user's policies are revoked from the account with the SCIM integration. Learn more about [account owned tokens](/fundamentals/api/get-started/account-owned-tokens/).
63+
Account owned API tokens are recommended for SCIM Provisioning. User owned API tokens, while supported, may result in a broken SCIM connection in the event when the user's policies are revoked from the SCIM integration, or the [API access](/fundamentals/api/how-to/control-api-access/) is unexpectedly disabled. Learn more about [account owned tokens](/fundamentals/api/get-started/account-owned-tokens/).
5664
:::
5765

5866
2. Under **Account Resources**, select the specific account to include or exclude from the dropdown menu, if applicable.

src/content/docs/fundamentals/account/account-security/scim-setup/okta.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ import { Render } from "~/components";
99

1010
<Render file="idp-group-deprecation" />
1111

12+
Once you have [gathered the required data](/fundamentals/account/account-security/scim-setup/#gather-the-required-data), the following steps will be required to finish the provisioning with Okta.
13+
1214
## Set up your Okta SCIM application
1315

1416
1. In the Okta dashboard, go to **Applications** > **Applications**.
@@ -43,4 +45,4 @@ The **Update User Attributes** option is not supported.
4345

4446
To verify the integration, select **View Logs** in the Okta SCIM application, and check the Audit Logs in the Cloudflare dashboard by navigating to **Manage Account** > **Audit Log**.
4547

46-
This will provision all of the users in the group(s) affected to your Cloudflare account with "minimal account access."
48+
This will provision all of the users in the group(s) affected to your Cloudflare account with "minimal account access."

0 commit comments

Comments
 (0)