Skip to content

Commit a0e0715

Browse files
mcescalanteMike Escalante
andauthored
Add expected behaviors for user lifecycle management to dash SCIM docs (#20494)
Co-authored-by: Mike Escalante <[email protected]>
1 parent c23224b commit a0e0715

File tree

1 file changed

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

1 file changed

+22
-10
lines changed

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

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

66
---
77

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

1010
:::note
1111
Cloudflare Zero Trust also supports SCIM for onboarding users to Cloudflare Access. [Learn more](/cloudflare-one/identity/users/scim/)
@@ -14,7 +14,7 @@ Cloudflare Zero Trust also supports SCIM for onboarding users to Cloudflare Acce
1414
## Limitations
1515

1616
- If a user is the only Super Administrator on an Enterprise account, they will not be deprovisioned.
17-
- 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.
17+
- 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.
1919

2020
## Prerequisites
@@ -31,7 +31,7 @@ Accounts provisioned with SCIM need to verify their email addresses.
3131
---
3232
## Gather the required data
3333

34-
To start, you will need to collect a couple of pieces of data from Cloudflare and set these aside for later use.
34+
To start, you will need to collect a couple of pieces of data from Cloudflare and set these aside for later use.
3535

3636
### Get your Account ID
3737

@@ -91,26 +91,26 @@ To start, you will need to collect a couple of pieces of data from Cloudflare an
9191
1. In **Provisioning to App**, select **Edit**.
9292
2. Enable **Create Users** and **Deactivate Users**. Select **Save**.
9393
3. In the integration page, go to **Assignments** > **Assign** > **Assign to Groups**.
94-
4. Choose the group(s) that you want to provision to Cloudflare.
94+
4. Choose the group(s) that you want to provision to Cloudflare.
9595
5. Select **Done**.
9696

9797
This will provision all of the users in the group(s) affected to your Cloudflare account with "minimal account access."
9898

99-
### Configure user permissions
99+
### Configure user permissions
100100

101101
There are two options for managing user permissions:
102102

103-
* Manage your user permissions on a per-user basis in the Cloudflare 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.
103+
* Manage your user permissions on a per-user basis in the Cloudflare 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.
105105

106106
1. Go to your SCIM application in the App Integration Catalog, then select **Provisioning**.
107107
2. Under **To App*, select **Edit**.
108108
3. Enable **Create Users** and **Deactivate Users**. Select **Save**.
109109
4. Go to **Push Groups**.
110110
5. Select **+ Push Groups**, then **Find groups by name**.
111-
6. Enter the name of the group(s) that you want to sync to Cloudflare.
111+
6. Enter the name of the group(s) that you want to sync to Cloudflare.
112112
7. Choose **Link Group**.
113-
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+
8. Cloudflare provisioned user groups are named in the pattern `CF-<accountID> - <Role Name>`. Choose the appropriate group that maps to your target role.
114114
9. Disable **Rename groups**. Select **Save**.
115115
10. Within the **Push Groups** tab, select **Push Groups**.
116116
11. Add the groups you created.
@@ -153,5 +153,17 @@ Refer to the list of [Roles](/fundamentals/setup/manage-members/roles/) for more
153153
7. Select **Start provisioning** to view the new users and groups populated on the Cloudflare dashboard.
154154

155155
:::note
156-
To successfully provision with Microsoft Entra ID, the `user principal name` and `email` fields must match. These values are case-sensitive.
156+
To successfully provision with Microsoft Entra ID, the `user principal name` and `email` fields must match. These values are case-sensitive.
157157
:::
158+
159+
## Expected behaviors
160+
161+
Expectations for user lifecycle management with SCIM:
162+
163+
| Expected Cloudflare dash behavior | Identity provider action |
164+
| ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
165+
| User is added to account as member | Assign the user to a SCIM application. They will be assigned the Minimal Account Access role so that their dash experience is not broken. |
166+
| User is removed from account as member | Unassign the user from the SCIM application. |
167+
| Add role to user | Add the user to a group in the IdP which is pushed via SCIM. They must also be assigned to the SCIM application and exist as an account member. |
168+
| Remove role from user | Remove the user from the corresponding group in the IdP. |
169+
| Retain user in account but with no permissions | Remove the user from all role groups but leave them assigned to the SCIM application. They will be an account member with only the role Minimal Account Access. |

0 commit comments

Comments
 (0)