Skip to content

Commit 849f086

Browse files
committed
Update SCIM docs for Okta
1 parent acf6ab7 commit 849f086

File tree

1 file changed

+35
-22
lines changed
  • src/content/docs/fundamentals/setup/account/account-security

1 file changed

+35
-22
lines changed

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

Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,42 @@ updated: 2024-12-04
55

66
---
77

8-
By connecting a System for Cross-domain Identity Management (SCIM) provider, you can provision access to the Cloudflare dashboard on a per-user basis, through your identity provider (IdP).
8+
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.
99

10-
Currently, we only support SCIM connections for Enterprise customers using Okta or Microsoft Entra. If you are an Enterprise customer using Okta or Microsoft Entra, and you are interested in setting up SCIM support, follow the steps below.
10+
:::note
11+
12+
Cloudflare Zero Trust also supports SCIM for onboarding users to Cloudflare Access. [Learn more](/cloudflare-one/identity/users/scim/)
13+
:::
1114

1215
## Limitations
1316

1417
- If a user is the only Super Administrator on an Enterprise account, they will not be deprovisioned.
15-
- Cloudflare currently only supports [Account-scoped Roles](/fundamentals/setup/manage-members/roles/#account-scoped-roles) and does not support Domain-scoped Roles provisioning via SCIM. We are working on this limitation.
16-
- Cloudflare does not currently allow custom group names to leave space for future development.
18+
- Cloudflare currently only supports [Account-scoped Roles](/fundamentals/setup/manage-members/roles/#account-scoped-roles) and does not support Domain-scoped Roles provisioning via SCIM.
19+
- Cloudflare does not allow custom user groups.
1720

1821
## Prerequisites
1922

2023
- Cloudflare provisioning with SCIM is only available to Enterprise customers using Okta or Microsoft Entra.
21-
- In Cloudflare, [Super Administrator](/fundamentals/setup/manage-members/roles/) access on the account.
22-
- In your identity provider, the ability to create applications and groups.
24+
- You must be a [Super Administrator](/fundamentals/setup/manage-members/roles/) on the account.
25+
- In your identity provider, you must have the ability to create applications and groups.
2326

2427
:::note
2528

2629
Accounts provisioned with SCIM need to verify their email addresses.
2730
:::
2831

2932
---
33+
## Gather required data
34+
35+
To start, you will need to collect a couple of pieces of data from Cloudflare and set these aside for later use.
36+
37+
### Get your Account ID
3038

31-
## Create an API token
39+
1. Navigate to the Account you want to configure for SCIM
40+
41+
2. In your browser's navigation bar, copy the Account ID from the URL. The URL should be in the format `https://dash.cloudflare.com/<accountID>`
42+
43+
### Create an API token
3244

3345
1. [Create an API token](/fundamentals/api/get-started/create-token/) with the following permissions:
3446

@@ -71,33 +83,34 @@ Accounts provisioned with SCIM need to verify their email addresses.
7183

7284
1. In your integration page, go to **Provisioning** > **Configure API Integration**.
7385
2. Enable **Enable API Integration**.
74-
3. In SCIM 2.0 Base URL, enter: `https://api.cloudflare.com/client/v4/accounts/<your_account_ID>/scim/v2`.
86+
3. In SCIM 2.0 Base URL, enter: `https://api.cloudflare.com/client/v4/accounts/<accountID>/scim/v2`.
7587
4. In OAuth Bearer Token, enter your API token value.
76-
5. Disable **Import Groups**.
77-
6. Select **Save**.
88+
5. Select **Save**.
7889

7990
### Set up your SCIM users.
8091

8192
1. In **Provisioning to App**, select **Edit**.
8293
2. Enable **Create Users** and **Deactivate Users**. Select **Save**.
8394
3. In the integration page, go to **Assignments** > **Assign** > **Assign to Groups**.
84-
4. Assign users to your Cloudflare SCIM group.
95+
4. Choose group(s) that you want to provision to Cloudflare.
8596
5. Select **Done**.
8697

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

89-
### Configure user permissions on Okta
100+
### Configure user permissions
90101

91-
1. Go to **Directory** > **Groups** > **Add group** and add groups with the following names:
92-
`CF-<your_account_ID> - <Role_Name>`
93-
:::note
102+
There are two options for managing user permissions
103+
* Manage your user permissions on a per-user basis in the Dashboard, API, or using Terraform.
104+
* Map your IdP groups to a Cloudflare built-in [Role](/fundamentals/setup/manage-members/roles/). Groups may only be linked to one role.
94105

95-
Refer to the list of available [Roles](/fundamentals/setup/manage-members/roles/) for more details.
96-
:::
97-
2. Go to your SCIM application in the App Integration Catalog, then select **Provisioning**.
98-
3. Select **Edit**.
99-
4. Enable **Create Users** and **Deactivate Users**. Select **Save**.
100-
5. Go to **Push Groups** and make sure the appropriate group matches the existing group of the same name on Cloudflare.
106+
1. Go to your SCIM application in the App Integration Catalog, then select **Provisioning**.
107+
2. Under **To App*, select **Edit**.
108+
3. Enable **Create Users** and **Deactivate Users**. Select **Save**.
109+
4. Go to **Push Groups**
110+
5. Click **+ Push Groups**, then **Find groups by name**
111+
6. Type in the name of the group(s) you want to sync to Cloudflare.
112+
7. Choose Link Group
113+
8. Cloudflare provisioned user groups named in the pattern `CF-<accountID> - <Role Name>`. Choose the appropriate group that maps to your target role.
101114
6. Disable **Rename groups**. Select **Save**.
102115
7. Within the **Push Groups** tab, select **Push Groups**.
103116
8. Add the groups you created.

0 commit comments

Comments
 (0)