-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Update SCIM documentation with role mapping details #19734
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,5 +47,54 @@ Prefect Cloud resources. This allows your IT team to control access to Prefect C | |
|
|
||
| ## SCIM Provisioning | ||
|
|
||
| Enterprise plans have access to SCIM for user provisioning. | ||
| The SSO tab provides access to enable SCIM provisioning. | ||
| Enterprise plans have access to SCIM (System for Cross-domain Identity Management) for automated user and team provisioning. | ||
|
|
||
| SCIM enables automatic provisioning and de-provisioning of users and teams based on your identity provider's directory. | ||
| When users are added, removed, or have their group memberships changed in your identity provider, these changes are | ||
| automatically reflected in Prefect Cloud. | ||
|
|
||
| ### Enable SCIM provisioning | ||
|
|
||
| The SSO tab provides access to enable SCIM provisioning for your account. | ||
|
|
||
| ### Role mapping | ||
|
|
||
| SCIM supports role mapping, which allows you to automatically assign Prefect Cloud account roles based on directory | ||
| group memberships configured in your identity provider. | ||
|
|
||
| #### Account roles | ||
|
|
||
| Directory groups can be mapped to the following Prefect Cloud account roles: | ||
|
|
||
| - **Owner**: Full account control including billing and account management | ||
| - **Admin**: Account management capabilities, can invite users and manage workspaces | ||
| - **Member**: Basic account access with workspace-level permissions | ||
|
|
||
| #### Configure role mapping | ||
|
|
||
| Role mapping is configured in your WorkOS organization dashboard: | ||
|
|
||
| 1. Navigate to your WorkOS dashboard | ||
| 2. Select your organization | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe it'll go directly to their organization when they go through the link. |
||
| 3. Go to Directory Sync settings | ||
| 4. Click "Configure role assignment" | ||
| 5. Map your identity provider groups to Prefect Cloud roles | ||
|
|
||
| When role mapping is configured: | ||
| - New users automatically receive the appropriate role based on their group memberships | ||
| - Users with multiple group memberships receive the role with the highest priority | ||
| - Users not in any mapped group receive the default "Member" role | ||
| - Role changes in your identity provider are reflected in Prefect Cloud automatically | ||
|
|
||
| #### Team management | ||
|
|
||
| Directory groups are automatically synchronized as teams in Prefect Cloud. See [Teams](/v3/how-to-guides/cloud/manage-users/manage-teams/) | ||
| for more information about SCIM team management. | ||
|
|
||
| ### Supported operations | ||
|
|
||
| SCIM provisioning supports the following operations: | ||
| - **User provisioning**: Automatic creation and updates of user accounts | ||
| - **User deprovisioning**: Automatic removal of user access when removed from the directory | ||
| - **Group/team synchronization**: Automatic creation and management of teams based on directory groups | ||
| - **Role assignment**: Automatic role assignment based on group memberships | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They need to go into the account settings to generate a link to get to the workos dashboard, might be worth calling out here.