Skip to content

Commit a30e125

Browse files
committed
Added additional content
1 parent cf03799 commit a30e125

File tree

1 file changed

+30
-45
lines changed
  • src/content/docs/fundamentals/setup/account/account-security

1 file changed

+30
-45
lines changed

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

Lines changed: 30 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@ This section covers SCIM provisioning for the Cloudflare dashboard only. If you
1616
- If a user is the only Super Administrator on an Enterprise account, they will not be deprovisioned.
1717
- 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.
1818
- Cloudflare does not allow custom user groups.
19+
- Cloudflare now supports the ability to sync custom User Groups via an upstream Identity Provider. This feature is in public beta Docs<Link> Blog<Link>
1920

2021
## Prerequisites
2122

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

@@ -47,13 +48,11 @@ To start, you will need to collect a couple of pieces of data from Cloudflare an
4748
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/).
4849
:::
4950

50-
2. Under **Account Resources**, select the specific account to include or exclude from the dropdown menu, if applicable.
51+
2. Select **Continue to summary**.
5152

52-
3. Select **Continue to summary**.
53+
3. Validate the permissions and select **Create Token**.
5354

54-
4. Validate the permissions and select **Create Token**.
55-
56-
5. Copy the token value.
55+
4. Copy the token value.
5756

5857
---
5958

@@ -81,43 +80,28 @@ The **Update User Attributes** option is not supported.
8180

8281
1. In your integration page, go to **Provisioning** > **Configure API Integration**.
8382
2. Enable **Enable API Integration**.
84-
3. In SCIM 2.0 Base URL, enter: `https://api.cloudflare.com/client/v4/accounts/<accountID>/scim/v2`.
85-
4. In OAuth Bearer Token, enter your API token value.
86-
5. Select **Save**.
83+
3. In SCIM 2.0 Base URL, enter: `https://api.cloudflare.com/client/v4/accounts/<accountID>/scim/v2`, substituting `accountID` for your [Cloudflare Account ID](/fundamentals/setup/account/account-security/scim-setup/#get-your-account-id).
84+
4. In the **OAuth Bearer Token** field, enter your API token value.
85+
5. Deselect **Import Groups**.
86+
8787

88-
### Set up your SCIM users
88+
### Set up your SCIM users and groups
8989

9090
1. In **Provisioning to App**, select **Edit**.
9191
2. Enable **Create Users** and **Deactivate Users**. Select **Save**.
92-
3. In the integration page, go to **Assignments** > **Assign** > **Assign to Groups**.
93-
4. Choose the group(s) that you want to provision to Cloudflare.
94-
5. Select **Done**.
95-
96-
This will provision all of the users in the group(s) affected to your Cloudflare account with "minimal account access."
92+
3. Select **Done**.
93+
4. In the Assignments tab, add the users you want to synchronize with Cloudflare Dash. You can add users in batches by assigning a group. If a user is removed from the application assignment via either direct user assignment or removed from the group that was assigned to the app, this will trigger a deprovisioning event from Okta to Cloudflare.
94+
5. In the Push Groups tab, add the Okta groups you want to synchronize with Cloudflare Dash. You can view these groups in the dash under Manage Account > Manage members > Members > User Groups.
9795

98-
### Configure user permissions
99-
100-
Two options exist for managing user permissions:
101-
102-
* Manage your user permissions on a per-user basis in the Cloudflare dashboard, API, or using Terraform.
103-
* Map your IdP groups to a Cloudflare built-in [Role](/fundamentals/setup/manage-members/roles/). Groups may only be linked to one role.
96+
:::note
97+
You must have opted into the Cloudflare User Groups Public Beta to synchronize groups from Okta to Cloudflare. Refer to the [Usesr Groups](/fundamentals/setup/manage-members/user-groups/) documentation for more information.
98+
:::
10499

105-
1. Go to your SCIM application in the App Integration Catalog, then select **Provisioning**.
106-
2. Under **To App*, select **Edit**.
107-
3. Enable **Create Users** and **Deactivate Users**. Select **Save**.
108-
4. Go to **Push Groups**.
109-
5. Select **+ Push Groups**, then **Find groups by name**.
110-
6. Enter the name of the group(s) that you want to sync to Cloudflare.
111-
7. Choose **Link Group**.
112-
8. Cloudflare provisioned user groups are named in the pattern `CF-<accountID> - <Role Name>`. Choose the appropriate group that maps to your target role.
113-
9. Disable **Rename groups**. Select **Save**.
114-
10. Within the **Push Groups** tab, select **Push Groups**.
115-
11. Add the groups you created.
116-
12. Select **Save**.
100+
To verify the integration, select **View Logs** in the Okta SCIM application, and check the Cloudflare Dash Audit Logs by navigating to **Manage Account** > **Audit Log**.
117101

118-
Adding any users to these groups will grant them the role. Removing the users from the identity provider will remove them from the associated role.
102+
To grant permissions to Users & Groups in Cloudflare, refer to the Permission Policies guide.
119103

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

122106
## Provision with Microsoft Entra ID
123107

@@ -137,24 +121,25 @@ Adding any users to these groups will grant them the role. Removing the users fr
137121

138122
### Configure user permissions in Microsoft Entra ID
139123

140-
Currently, groups need to match a specific format to provision specific Cloudflare account-level roles. Cloudflare is in the process of adding Cloudflare Groups, which can take in freeform group names in the future.
124+
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.)
141125

142-
These permissions work on an exact string match with the form `CF-<your_account_ID> - <Role_Name>`
126+
:::note
127+
You must have opted into the Cloudflare User Groups Public Beta to synchronize groups from Okta to Cloudflare<link to User Groups docs>
143128

144-
Refer to the list of [Roles](/fundamentals/setup/manage-members/roles/) for more details.
129+
Currently, groups need to match a specific format to provision specific Cloudflare account-level roles. Cloudflare is in the process of adding Cloudflare Groups, which can take in freeform group names in the future.
130+
:::
145131

146-
1. To ensure that only required groups are provisioned, go to your Microsoft Entra ID instance.
147-
2. Under Manage on the sidebar menu, select **Provisioning**.
148-
3. Select **Provision Entra Groups** in Mappings.
149-
4. Select **All records** under Source Object Scope.
150-
5. Select **Add scoping filter** and create the appropriate filtering criteria to capture only the necessary groups.
151-
6. Save the Attribute Mapping by selecting **OK** and return to the Enterprise Application Provisioning overview page.
152-
7. Select **Start provisioning** to view the new users and groups populated on the Cloudflare dashboard.
132+
2. To begin syncing your Users & Groups into Cloudflare, navigate back to **Provisioning**, and under **Provisioning Status**, check *On*, then select **Save**.
153133

154134
:::note
155135
To successfully provision with Microsoft Entra ID, the `user principal name` and `email` fields must match. These values are case-sensitive.
156136
:::
157137

138+
3. To check which users and groups were synchronized, select **Provisioning logs**.
139+
4. To verify the integration, select **Provisioning Logs** in Entra ID application, and check the Cloudflare Dash Audit Logs by navigating to **Manage Account** > **Audit Log**.
140+
5. To grant permissions to Users & Groups in Cloudflare, refer to the Permission Policies guide.
141+
142+
158143
### Automate Cloudflare's SCIM integration
159144

160145
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.

0 commit comments

Comments
 (0)