You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/fundamentals/setup/account/account-security/scim-setup.mdx
+35-22Lines changed: 35 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,30 +5,42 @@ updated: 2024-12-04
5
5
6
6
---
7
7
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.
9
9
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
+
:::
11
14
12
15
## Limitations
13
16
14
17
- 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.
17
20
18
21
## Prerequisites
19
22
20
23
- 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.
23
26
24
27
:::note
25
28
26
29
Accounts provisioned with SCIM need to verify their email addresses.
27
30
:::
28
31
29
32
---
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
30
38
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
32
44
33
45
1.[Create an API token](/fundamentals/api/get-started/create-token/) with the following permissions:
34
46
@@ -71,33 +83,34 @@ Accounts provisioned with SCIM need to verify their email addresses.
71
83
72
84
1. In your integration page, go to **Provisioning** > **Configure API Integration**.
73
85
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`.
75
87
4. In OAuth Bearer Token, enter your API token value.
76
-
5. Disable **Import Groups**.
77
-
6. Select **Save**.
88
+
5. Select **Save**.
78
89
79
90
### Set up your SCIM users.
80
91
81
92
1. In **Provisioning to App**, select **Edit**.
82
93
2. Enable **Create Users** and **Deactivate Users**. Select **Save**.
83
94
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.
85
96
5. Select **Done**.
86
97
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."
88
99
89
-
### Configure user permissions on Okta
100
+
### Configure user permissions
90
101
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.
94
105
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.
101
114
6. Disable **Rename groups**. Select **Save**.
102
115
7. Within the **Push Groups** tab, select **Push Groups**.
0 commit comments