Skip to content

Commit ddcc254

Browse files
themr0chmanwani-rhGerry-Fordenickboldt
authored
RHIDP-3794 - update Authentication book introduction (#460) (#535)
Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> Co-authored-by: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com> Co-authored-by: Nick Boldt <nboldt@redhat.com>
1 parent acf7457 commit ddcc254

File tree

1 file changed

+41
-29
lines changed

1 file changed

+41
-29
lines changed

assemblies/assembly-enabling-authentication.adoc

Lines changed: 41 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,53 @@
11
[id='enabling-authentication']
22
= Enabling authentication in {product}
33

4-
Authentication within {product} facilitates user sign-in, identification, and access to external resources.
5-
It supports multiple authentication providers.
4+
Depending on your organization's security policies, you might require to identify and authorize users before giving them access to resources, such as {product}.
65

7-
Authentication providers are typically used in the following ways:
6+
In {product-short}, authentication and authorization are two separate processes:
87

9-
- One provider for sign-in and identification.
10-
- Additional providers for accessing external resources.
8+
. Authentication defines the user identity, and passes on this information to {product-short}.
9+
Read the following chapters to configure authentication in {product-short}.
1110

12-
The {product} supports the following authentication providers:
11+
. Authorization defines what the authenticated identity can access or do in {product-short}.
12+
See link:{authorization-book-url}[{authorization-book-title}].
1313

14-
//Auth0:: `auth0`
15-
//Atlassian:: `atlassian`
16-
Microsoft Azure::
17-
`microsoft`
18-
//Microsoft Azure Easy Auth:: `azure-easyauth`
19-
//Bitbucket:: `bitbucket`
20-
//Bitbucket Server:: `bitbucketServer`
21-
//Cloudflare Access:: `cfaccess`
22-
GitHub:: `github`
23-
//GitLab:: `gitlab`
24-
//Google:: `google`
25-
//Google IAP:: `gcp-iap`
26-
Keycloak:: `oidc`
27-
//Okta:: `okta`
28-
//OAuth 2 Custom Proxy:: `oauth2Proxy`
29-
//OneLogin:: `onelogin`
30-
//SAML:: `saml`
14+
[TIP]
15+
.Not recommended for production
16+
====
17+
To explore {product-short} features, you can enable the guest user to skip configuring authentication and authorization, log in as the guest user, and access all the features.
18+
====
3119

32-
For each provider that you want to use, follow the dedicated procedure to complete the following tasks:
20+
The authentication system in {product-short} is handled by external authentication providers.
21+
22+
{product-short} supports following authentication providers:
23+
24+
* Red Hat Single-Sign On (RHSSO)
25+
* GitHub
26+
* Microsoft Azure
27+
28+
To identify users in {product-short}, configure:
29+
30+
* One (and only one) authentication provider for sign-in and identification.
31+
* Optionally, additional authentication providers for identification, to add more information to the user identity, or enable access to additional external resources.
32+
33+
For each authentication provider, set up the shared secret that the authentication provider and {product-short} require to communicate, first in the authentication provider, then in {product-short}.
34+
35+
{product-short} stores user identity information in the {product-short} software catalog.
36+
37+
[TIP]
38+
.Not recommended for production
39+
====
40+
To explore the authentication system and 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.
41+
====
42+
43+
To get, store, and update additional user information, such as group or team ownership, with the intention to use this data to define authorization policies, provision users and groups in the {product-short} software catalog.
44+
45+
[IMPORTANT]
46+
====
47+
{product-short} uses a one-way synchronization system to provision users and groups from your authentication system to the {product-short} software catalog.
48+
Therefore, deleting users and groups by using {product-short} Web UI or REST API might have unintended consequences.
49+
====
3350

34-
. Set up the shared secret that the authentication provider and {product} require to communicate.
35-
. Configure {product} to use the authentication provider.
3651

3752

3853
include::assembly-authenticationg-with-the-guest-user.adoc[leveloffset=+1]
@@ -46,6 +61,3 @@ include::assembly-auth-provider-github.adoc[leveloffset=+1]
4661

4762
include::assembly-auth-provider-oidc.adoc[leveloffset=+1]
4863

49-
50-
//include::modules/auth/proc-adding-gitlab-oauth-as-an-authentication-provider.adoc[leveloffset=+1]
51-

0 commit comments

Comments
 (0)