Skip to content

Commit e1e8dfb

Browse files
jmagakGitHub Actions
and
GitHub Actions
authored
RHIDP-5681: Update the enabling authentication with rhbk (redhat-developer#960)
* Update the enabling authentication with rhbk * Update the enabling authentication with rhbk * Update the enabling authentication with rhbk --------- Co-authored-by: GitHub Actions <[email protected]>
1 parent 9175aa9 commit e1e8dfb

File tree

1 file changed

+48
-10
lines changed

1 file changed

+48
-10
lines changed

modules/authentication/proc-enabling-authentication-with-rhbk.adoc

+48-10
Original file line numberDiff line numberDiff line change
@@ -39,20 +39,59 @@ Save the value for the next step:
3939
[source,yaml]
4040
----
4141
auth:
42-
environment: production # <1>
42+
environment: production
4343
providers:
4444
oidc:
4545
production:
46-
metadataUrl: ${AUTH_OIDC_METADATA_URL} # <2>
46+
metadataUrl: ${AUTH_OIDC_METADATA_URL}
4747
clientId: ${AUTH_OIDC_CLIENT_ID}
4848
clientSecret: ${AUTH_OIDC_CLIENT_SECRET}
49-
signInPage: oidc # <3>
49+
prompt: auto
50+
signInPage: oidc
5051
----
51-
<1> Mark the environment as `production` and disable the Guest login option in the {product-short} login page.
52-
<2> Apply the {rhbk} credentials configured in your {product-short} secrets.
53-
<3> To enable the {rhbk} provider as your {product-short} sign-in provider.
52+
53+
`environment: production`::
54+
Mark the environment as `production` to hide the Guest login in the {product-short} home page.
55+
56+
`metadataUrl`, `clientId`, `clientSecret`::
57+
To configure the OIDC provider with your secrets.
58+
59+
`sigInPage: oidc`::
60+
To enable the OIDC provider as default sign-in provider.
61+
62+
`prompt: auto`::
63+
To allow the identity provider to automatically determine whether to prompt for credentials or bypass the login redirect if an active {rhsso} session exists.
64+
65+
[NOTE]
66+
====
67+
If `prompt: auto` is not set, the identity provider defaults to `prompt: none`, which assumes that you are already logged in and rejects sign-in requests without an active session.
68+
====
69+
70+
Optional: Consider adding the following optional fields:
71+
72+
`dangerouslyAllowSignInWithoutUserInCatalog: true`::
5473
+
55-
.. Optional: Consider adding the following optional fields:
74+
--
75+
To enable authentication without requiring to provision users in the {product-short} software catalog.
76+
77+
WARNING: Use this option to explore {product-short} features, but do not use it in production.
78+
79+
.`{my-app-config-file}` fragment with optional field to allow authenticating users absent from the software catalog
80+
[source,yaml]
81+
----
82+
auth:
83+
environment: production
84+
providers:
85+
oidc:
86+
production:
87+
metadataUrl: ${AUTH_OIDC_METADATA_URL}
88+
clientId: ${AUTH_OIDC_CLIENT_ID}
89+
clientSecret: ${AUTH_OIDC_CLIENT_SECRET}
90+
prompt: auto
91+
signInPage: oidc
92+
dangerouslyAllowSignInWithoutUserInCatalog: true
93+
----
94+
--
5695

5796
`callbackUrl`::
5897
{rhbk} callback URL.
@@ -112,14 +151,14 @@ After successful authentication, the user signing in must be resolved to an exis
112151
+
113152
The authentication provider tries each sign-in resolver in order until it succeeds, and fails if none succeed.
114153
+
115-
WARNING: In production mode, only configure one resolver to ensure users are securely matched.
154+
WARNING: In production mode, only configure one resolver to ensure users are securely matched.
116155
`resolver`::::
117156
Enter the sign-in resolver name.
118157
Available values:
119158
* `emailLocalPartMatchingUserEntityName`
120159
* `emailMatchingUserEntityProfileEmail`
121160
* `preferredUsernameMatchingUserEntityName`
122-
+
161+
123162
.`{my-app-config-file}` fragment with optional `resolvers` list
124163
[source,yaml]
125164
----
@@ -197,4 +236,3 @@ If multiple valid refresh tokens are issued due to frequent refresh token reques
197236
. Go to the {product-short} login page.
198237
. Your {product-short} sign-in page displays *Sign in using OIDC* and the Guest user sign-in is disabled.
199238
. Log in with OIDC by using the saved **Username** and **Password** values.
200-

0 commit comments

Comments
 (0)