generated from redhat-developer/new-project-template
-
Notifications
You must be signed in to change notification settings - Fork 58
RHIDP-6735 - Added high-level overview of auth and user provisioning #1186
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
7ac8c9d
RHIDP-6735 - Added high-level overview of auth and user provisioning
themr0c 830a8a3
Complete rewrite with the assistance of NotebookLM.
themr0c 7654304
Merge branch 'main' into RHIDP-6735
themr0c 0bb5607
Update assemblies/assembly-enabling-authentication.adoc
themr0c 88a3faf
Update modules/authentication/con-understanding-authentication-and-us…
themr0c fe8af22
Update modules/authentication/con-understanding-authentication-and-us…
themr0c 47b344d
Update modules/authentication/con-understanding-authentication-and-us…
themr0c becf9fa
Update modules/authentication/con-understanding-authentication-and-us…
themr0c 2e9f1ca
Update modules/authentication/con-understanding-authentication-and-us…
themr0c aecf0ad
Update modules/authentication/con-understanding-authentication-and-us…
themr0c 3039d26
Update modules/authentication/con-understanding-authentication-and-us…
themr0c 83e1844
Update modules/authentication/con-understanding-authentication-and-us…
themr0c e23fc9a
Update modules/authentication/con-understanding-authentication-and-us…
themr0c 779adae
Merge branch 'main' into RHIDP-6735
themr0c d3c6e7e
Merge branch 'main' into RHIDP-6735
themr0c bb31469
Update modules/authentication/con-understanding-authentication-and-us…
themr0c 987c703
Update modules/authentication/con-understanding-authentication-and-us…
themr0c 4230810
Update modules/authentication/con-understanding-authentication-and-us…
themr0c 0f54691
Update modules/authentication/con-understanding-authentication-and-us…
themr0c 8bfe454
Apply suggestions from code review
themr0c 1d5f148
Merge branch 'main' into RHIDP-6735
themr0c cd20aba
Update modules/authentication/con-understanding-authentication-and-us…
themr0c 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
38 changes: 38 additions & 0 deletions
38
modules/authentication/con-understanding-authentication-and-user-provisioning.adoc
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,38 @@ | ||
| = Understanding authentication and user provisioning | ||
|
|
||
| This module provides an overview of how authentication and user provisioning function within {product}. | ||
| Learn about the process from user sign-in to the creation of user and group entities in the software catalog, and understand the roles played by the different authentication and catalog plugins. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Understanding this process is essential for successfully link:{configuring-book-url}[configuring your {product-short} instance], link:{authorization-book-url}[securing access through authorization], and enabling features that rely on synchronized user and group data. | ||
|
|
||
| When a user attempts to access {product-short}, {product-short} redirects them to a configured authentication provider, such as xref:assembly-authenticating-with-rhbk[{rhbk-brand-name} ({rhbk})], xref:authenticating-with-github[GitHub], or xref:assembly-authenticating-with-microsoft-azure[{azure-brand-name}]. | ||
| This external Identity Provider (IdP) is responsible for authenticating the user. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| On successful authentication, the {product-short}'s authentication plugin, configured in your `{my-app-config-file}` file, processes the response from the IdP, resolves the identity in the {product-short} software catalog, and establishes a user session within {product-short}. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| User and group data needs to be provisioned from the Identity Provider to the {product-short} software catalog to fully enable catalog features. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| This is handled asynchronously by catalog provider plugins, also configured in your `{my-app-config-file}` file. | ||
| These plugins, query the IdP for relevant user and group information and create or update corresponding entities in the {product-short} catalog. | ||
| Scheduled provisioning ensures that the catalog accurately reflects the users and groups in your organization. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Configuring authentication and user provisioning is critical for several reasons. | ||
themr0c marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * First, it secures your Developer Hub instance by ensuring only authenticated users can gain access. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * Second, it enables authorization by allowing you to define access controls based on user and group memberships synchronized from your IdP. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * Finally, provisioning user and group data to the catalog is necessary for various catalog features that rely on understanding entity ownership and relationships between users, groups, and software components. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Without this provisioning step, features like displaying who owns a component in the catalog may not function correctly. | ||
| [TIP] | ||
| .Not recommended for production | ||
| ==== | ||
| To explore {product-short} features, you can: | ||
| * To use {product-short} without external IdP, xref:authenticating-with-the-guest-user_{context}[enable the guest user] to skip configuring authentication and authorization, log in as the guest user, and access all {product-short} features. | ||
| * To use {product-short} without authorization policies, you can bypass the {product-short} software catalog and start using {product-short} without provisioning the {product-short} software catalog. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ==== | ||
| [IMPORTANT] | ||
| ==== | ||
| {product-short} uses a one-way synchronization system to provision users and groups from your authentication system to the {product-short} software catalog. | ||
| Therefore, deleting users and groups by using {product-short} Web UI or REST API might have unintended consequences. | ||
themr0c marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ==== | ||
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.