You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/admin/proc-using-azure-auth-provider.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ The `core-plugin-api` package in {product-short} comes integrated with Microsoft
7
7
.Prerequisites
8
8
* You have deployed {product-short} on AKS.
9
9
10
-
For more information, see xref:{installing-on-aks-book-url}#assembly-install-rhdh-aks[Installing Red Hat Developer Hub on Azure Kubernetes Service (AKS)].
10
+
For more information, see xref:{installing-on-aks-book-url}#assembly-install-rhdh-aks[Installing {product} on {aks-name} ({aks-short})].
11
11
12
12
* You have created registered your application in Azure portal. For more information, see https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app[Register an application with the Microsoft identity platform].
Copy file name to clipboardExpand all lines: modules/authentication/proc-creating-a-custom-transformer-to-provision-users-from-rhsso-to-the-software-catalog.adoc
= Creating a custom transformer to provision users from {rhsso-brand-name} ({rhsso}) to the software catalog
3
3
4
-
To customize how RHSSO users and groups are mapped to {product} entities, you can create a backend module that uses the `keycloakTransformerExtensionPoint` to provide custom user and group transformers for the Keycloak backend.
4
+
To customize how {rhsso} users and groups are mapped to {product} entities, you can create a backend module that uses the `keycloakTransformerExtensionPoint` to provide custom user and group transformers for the Keycloak backend.
5
5
6
6
.Prerequisites
7
-
* You have xref:provisioning-users-from-rhsso-to-the-software-catalog[enabled provisioning users from Red Hat Single-Sign On (RHSSO) to the software catalog].
7
+
* You have xref:provisioning-users-from-rhsso-to-the-software-catalog[enabled provisioning users from {rhsso-brand-name} ({rhsso}) to the software catalog].
8
8
9
9
.Procedure
10
10
. Create a new backend module with the `yarn new` command.
@@ -85,8 +85,8 @@ Check the console logs to verify that the synchronization is completed.
85
85
86
86
* After the first import is complete, navigate to the *Catalog* page and select **User** to view the list of users.
87
87
88
-
* When you select a user, you see the information imported from RHSSO.
88
+
* When you select a user, you see the information imported from {rhsso}.
89
89
90
-
* You can select a group, view the list, and access or review the information imported from RHSSO.
90
+
* You can select a group, view the list, and access or review the information imported from {rhsso}.
Copy file name to clipboardExpand all lines: modules/authentication/proc-enabling-authentication-with-rhsso.adoc
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,21 @@
1
1
[id="enabling-authentication-with-rhsso"]
2
-
= Enabling authentication with Red Hat Single-Sign On (RHSSO)
2
+
= Enabling authentication with {rhsso-brand-name} ({rhsso})
3
3
4
-
To authenticate users with Red Hat Single Sign-On (RHSSO), enable the OpenID Connect (OIDC) authentication provider in {product}.
4
+
To authenticate users with Red Hat Single Sign-On ({rhsso}), enable the OpenID Connect (OIDC) authentication provider in {product}.
5
5
6
6
7
7
.Prerequisites
8
8
* You link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html/administration_guide_for_red_hat_developer_hub/assembly-add-custom-app-file-openshift_admin-rhdh[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
9
-
* You have sufficient permissions in RHSSO to create and manage a realm.
9
+
* You have sufficient permissions in {rhsso} to create and manage a realm.
10
10
11
11
.Procedure
12
-
. To allow {product-short} to authenticate with RHSSO, complete the steps in RHSSO, to link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#realms-apps_[create a realm and a user] and link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#registering-app_[register the {product-short} application]:
12
+
. To allow {product-short} to authenticate with {rhsso}, complete the steps in {rhsso}, to link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#realms-apps_[create a realm and a user] and link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#registering-app_[register the {product-short} application]:
13
13
14
14
.. Use an existing realm, or link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#create-realm_[create a realm], with a distinctive **Name** such as __<my_realm>__.
15
15
Save the value for the next step:
16
-
* **RHSSO realm base URL**, such as: __<your_rhsso_URL>__/auth/realms/__<your_realm>__.
16
+
* **{rhsso} realm base URL**, such as: __<your_rhsso_URL>__/auth/realms/__<your_realm>__.
17
17
18
-
.. To register your {product-short} in RHSSO, in the created realm, link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#registering-app_[create a Client ID], with:
18
+
.. To register your {product-short} in {rhsso}, in the created realm, link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#registering-app_[create a Client ID], with:
19
19
... **Client ID**: A distinctive client ID, such as __<{product-very-short}>__.
20
20
... **Valid redirect URIs**: Set to the OIDC handler URL: `https://__<RHDH_URL>__/api/auth/oidc/handler/frame`.
21
21
... Navigate to the **Credentials** tab and copy the **Client secret**.
@@ -25,16 +25,16 @@ Save the value for the next step:
25
25
26
26
.. To prepare for the verification steps, in the same realm, get the credential information for an existing user or link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#create-user_[create a user]. Save the user credential information for the verification steps.
27
27
28
-
. To add your RHSSO credentials to your {product-short} secrets, edit your {product-short} secrets, such as `secrets-rhdh`, and add the following key/value pairs:
28
+
. To add your {rhsso} credentials to your {product-short} secrets, edit your {product-short} secrets, such as `secrets-rhdh`, and add the following key/value pairs:
29
29
+
30
30
`AUTH_OIDC_CLIENT_ID`:: Enter the saved **Client ID**.
31
31
`AUTH_OIDC_CLIENT_SECRET`:: Enter the saved **Client Secret**.
32
-
`AUTH_OIDC_METADATA_URL`:: Enter the saved **RHSSO realm base URL**.
32
+
`AUTH_OIDC_METADATA_URL`:: Enter the saved **{rhsso} realm base URL**.
33
33
34
-
. To set up the RHSSO authentication provider in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
34
+
. To set up the {rhsso} authentication provider in your {product-short} custom configuration, edit your custom {product-short} ConfigMap such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
35
35
+
36
36
--
37
-
.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with RHSSO
37
+
.`app-config-rhdh.yaml` fragment with mandatory fields to enable authentication with {rhsso}
= Provisioning users from Red Hat Single-Sign On (RHSSO) to the software catalog
2
+
= Provisioning users from {rhsso-brand-name} ({rhsso}) to the software catalog
3
3
4
4
.Prerequisites
5
-
* You xref:enabling-authentication-with-rhsso[enabled authentication with RHSSO].
5
+
* You xref:enabling-authentication-with-rhsso[enabled authentication with {rhsso}].
6
6
7
7
.Procedure
8
8
9
-
* To enable RHSSO member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
9
+
* To enable {rhsso} member discovery, edit your custom {product-short} ConfigMap, such as `app-config-rhdh`, and add the following lines to the `app-config-rhdh.yaml` content:
10
10
+
11
11
--
12
12
[id=keycloakOrgProviderId]
@@ -27,13 +27,13 @@ catalog:
27
27
Allow authentication only for users present in the {product-short} software catalog.
28
28
29
29
`baseUrl`::
30
-
Your RHSSO server URL, defined when xref:enabling-authentication-with-rhsso[enabling authentication with RHSSO].
30
+
Your {rhsso} server URL, defined when xref:enabling-authentication-with-rhsso[enabling authentication with {rhsso}].
31
31
32
32
`clientId`::
33
-
Your {product-short} application client ID in RHSSO, defined when xref:enabling-authentication-with-rhsso[enabling authentication with RHSSO].
33
+
Your {product-short} application client ID in {rhsso}, defined when xref:enabling-authentication-with-rhsso[enabling authentication with {rhsso}].
34
34
35
35
`clientSecret`::
36
-
Your {product-short} application client secret in RHSSO, defined when xref:enabling-authentication-with-rhsso[enabling authentication with RHSSO].
36
+
Your {product-short} application client secret in {rhsso}, defined when xref:enabling-authentication-with-rhsso[enabling authentication with {rhsso}].
37
37
38
38
Optional: Consider adding the following optional fields:
39
39
@@ -150,4 +150,4 @@ catalog:
150
150
{"class":"KeycloakOrgEntityProvider","level":"info","message":"Committed 3 Keycloak users and 2 Keycloak groups in 0.0 seconds.","plugin":"catalog","service":"backstage","taskId":"KeycloakOrgEntityProvider:default:refresh","taskInstanceId":"bf0467ff-8ac4-4702-911c-380270e44dea","timestamp":"2024-09-25 13:58:04"}
0 commit comments