-
Notifications
You must be signed in to change notification settings - Fork 25
[Hold] IdP integration - overview and UI only #767
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
Draft
Paul-Cornell
wants to merge
8
commits into
main
Choose a base branch
from
DOC-50-idp
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
a8b3e23
IdP integration
Paul-Cornell 9b9c9dc
Added more content based on design spec
Paul-Cornell 0e76d60
More IdP how-to steps based on Loom video
Paul-Cornell 846257a
Enterprise -> Business
Paul-Cornell ba7cf92
Enterprise -> Business, resolve merge conflicts
Paul-Cornell fbceb77
More minor updates for IdP
Paul-Cornell 33ea53a
Add remaining how-to steps for IdP
Paul-Cornell 728432b
Apply suggestions from code review
Paul-Cornell 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
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 |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| title: IdP overview | ||
| sidebarTitle: Overview | ||
| --- | ||
|
|
||
| <Note> | ||
| The following information applies only to dedicated instance and in-VPC deployments of [Unstructured Enterprise](/business/overview). | ||
|
|
||
| IdP integration is not available for Unstructured **Let's Go**, **Pay-As-You-Go**, or **Business SaaS** accounts. | ||
| </Note> | ||
|
|
||
| An _identity provider_ (IdP) is a service that manages and verifies the digital identities of users. | ||
| It authenticates who a user is and provides that information to other systems (known as _service providers_) to control access. | ||
| You can connect your organization's IdP to Unstructured so you can manage who has access across all your connected systems from one place. | ||
| Instead of having to manually create and manage user accounts and roles within your Unstructured account, Unstructured can use your organization's IdP to determine | ||
| things such as: | ||
|
|
||
| - Who can sign in to your Unstructured account's organizational accounts. | ||
| - Which roles and permissions they should have within your organizational accounts. | ||
| - Revoking access to your organizational accounts—for example, when someone leaves your organization. | ||
|
|
||
| ## Supported IdPs | ||
|
|
||
| Unstructured supports IdPs that use any of the following protocols: | ||
|
|
||
| - Keycloak OpenID Connect | ||
| - OpenID Connect v1.0 | ||
| - SAML 2.0 | ||
|
|
||
| ## IdP groups | ||
|
|
||
| _IdP groups_ are collections of users defined within your IdP—for example, an Engineering group, a Marketing group, or an | ||
| Administrators group. Unstructured can use your IdP groups to automatically assign roles and permissions within your Unstructured account | ||
| at the account level and for each of your account's workspaces. | ||
|
|
||
| ## Roles | ||
|
|
||
| _Roles_ are the sets of permissions that Unstructured can assign to your IdP groups—as well as to individual users separately within your Unstructed account, if needed— through | ||
| a common security best-practice technique called _role-based access control_ (RBAC). Unstructured has two kinds of roles: | ||
|
|
||
| - **Account roles**: These roles include **Super Administrator**, **Account Member**, and **Billing Administrator**. They apply at the account level. | ||
| - **Workspace roles**: These roles include **Workspace Administrator**, **Developer**, **Operator**, and **Viewer**. They apply to each of your account's workspaces. | ||
|
|
||
| [Learn more about these roles](/ui/account/roles). | ||
|
|
||
| ## Getting started | ||
|
|
||
| To have Unstructured connect your organization's IdP to your Unstructured account, contact your assigned | ||
| Unstructured Account Executive (AE) or Customer Success Manager (CSM). If you do not know who your assigned AE or CSM is, | ||
| email Unstructured Support at [support@unstructured.io](mailto:support@unstructured.io). | ||
|
|
||
| ## Next steps | ||
|
|
||
| After Unstructured has connected your organization's IdP to your Unstructured account, you can manage access by your IdP groups and individual users to your | ||
| Unstructured account's organizational accounts and their workspaces. To do this, you can use your | ||
| Unstructured account's user interface (UI). For details, see | ||
| [IdP management with the Unstructured UI](/business/idp/ui). | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.