libre.sh/keycloak-scim
4
0
Fork 0
Code Issues 15 Pull requests Releases 1 Activity Actions

Social Identity Providers documentation adjustments (#24840)

Browse source 
Closes #24601

Signed-off-by: Tomas Ondrusko <tondrusk@redhat.com>
This commit is contained in:
Tomas Ondrusko 2023-11-20 22:26:11 +01:00 committed by GitHub
parent fc2a3ba101
commit 8ac6120274
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 36 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/documentation/server_admin/topics/identity-broker/social/bitbucket.adoc
View file

@ -5,7 +5,7 @@ To log in with Bitbucket, perform the following procedure.
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `Bitbucket`. . From the *Add provider* list, select *Bitbucket*.
+ +
.Add identity provider .Add identity provider
image:images/bitbucket-add-identity-provider.png[Add Identity Provider] image:images/bitbucket-add-identity-provider.png[Add Identity Provider]
@ -14,7 +14,7 @@ image:images/bitbucket-add-identity-provider.png[Add Identity Provider]
. In a separate browser tab, perform the https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud/[OAuth on Bitbucket Cloud] process. When you click *Add Consumer*: . In a separate browser tab, perform the https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud/[OAuth on Bitbucket Cloud] process. When you click *Add Consumer*:
.. Paste the value of *Redirect URI* into the *Callback URL* field. .. Paste the value of *Redirect URI* into the *Callback URL* field.
.. Ensure you select *Email* and *Read* in the *Account* section to permit your application to read email. .. Ensure you select *Email* and *Read* in the *Account* section to permit your application to read email.
. Note the `Key` and `Secret` values Bitbucket displays when you create your consumer. . Note the *Key* and *Secret* values Bitbucket displays when you create your consumer.
. In {project_name}, paste the value of the `Key` into the *Client ID* field. . In {project_name}, paste the value of the `Key` into the *Client ID* field.
. In {project_name}, paste the value of the `Secret` into the *Client Secret* field. . In {project_name}, paste the value of the `Secret` into the *Client Secret* field.
. Click *Add*. . Click *Add*.

12
docs/documentation/server_admin/topics/identity-broker/social/facebook.adoc
View file

@ -4,7 +4,7 @@
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `Facebook`. . From the *Add provider* list, select *Facebook*.
+ +
.Add identity provider .Add identity provider
image:images/facebook-add-identity-provider.png[Add Identity Provider] image:images/facebook-add-identity-provider.png[Add Identity Provider]
@ -16,12 +16,12 @@ image:images/facebook-add-identity-provider.png[Add Identity Provider]
.Add a use case .Add a use case
image:images/meta-add-use-case.png[Add a use case] image:images/meta-add-use-case.png[Add a use case]
+ +
.. Select `Other`. .. Select *Other*.
+ +
.Select an app type .Select an app type
image:images/meta-select-app-type.png[Select an app type] image:images/meta-select-app-type.png[Select an app type]
+ +
.. Select `Consumer`. .. Select *Consumer*.
+ +
.Create an app .Create an app
image:images/meta-create-app.png[Create an app] image:images/meta-create-app.png[Create an app]
@ -34,13 +34,13 @@ image:images/meta-add-product.png[Add Product]
+ +
.. Click *Set Up* in the *Facebook Login* box. .. Click *Set Up* in the *Facebook Login* box.
.. Select *Web*. .. Select *Web*.
.. Enter the *Redirect URI's* value into the `Site URL` field and click *Save*. .. Enter the *Redirect URI's* value into the *Site URL* field and click *Save*.
.. In the navigation panel, select *App settings* - *Basic*. .. In the navigation panel, select *App settings* - *Basic*.
.. Click *Show* in the *App Secret* field. .. Click *Show* in the *App Secret* field.
.. Note the `App ID` and the `App Secret`. .. Note the *App ID* and the *App Secret*.
. Enter the https://developers.facebook.com/docs/facebook-login/guides/access-tokens[`App ID` and `App Secret`] values from your Facebook app into the *Client ID* and *Client Secret* fields in {project_name}. . Enter the https://developers.facebook.com/docs/facebook-login/guides/access-tokens[`App ID` and `App Secret`] values from your Facebook app into the *Client ID* and *Client Secret* fields in {project_name}.
. Click *Add* . Click *Add*
. Enter the required scopes into the *Default Scopes* field. By default, {project_name} uses the `email` scope. See https://developers.facebook.com/docs/graph-api[Graph API] for more information about Facebook scopes. . Enter the required scopes into the *Default Scopes* field. By default, {project_name} uses the *email* scope. See https://developers.facebook.com/docs/graph-api[Graph API] for more information about Facebook scopes.
{project_name} sends profile requests to `graph.facebook.com/me?fields=id,name,email,first_name,last_name` by default. The response contains the id, name, email, first_name, and last_name fields only. To fetch additional fields from the Facebook profile, add a corresponding scope and add the field name in the `Additional user's profile fields` configuration option field. {project_name} sends profile requests to `graph.facebook.com/me?fields=id,name,email,first_name,last_name` by default. The response contains the id, name, email, first_name, and last_name fields only. To fetch additional fields from the Facebook profile, add a corresponding scope and add the field name in the `Additional user's profile fields` configuration option field.

6
docs/documentation/server_admin/topics/identity-broker/social/github.adoc
View file

@ -7,15 +7,15 @@ To log in with GitHub, perform the following procedure.
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `Github`. . From the *Add provider* list, select *Github*.
+ +
.Add identity provider .Add identity provider
image:images/github-add-identity-provider.png[Add Identity Provider] image:images/github-add-identity-provider.png[Add Identity Provider]
+ +
. Copy the value of *Redirect URI* to your clipboard. . Copy the value of *Redirect URI* to your clipboard.
. In a separate browser tab, https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app[create an OAUTH app]. . In a separate browser tab, https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app[create an OAUTH app].
.. Enter the value of *Redirect URI* into the `Authorization callback URL` field when creating the app. .. Enter the value of *Redirect URI* into the *Authorization callback URL* field when creating the app.
.. Note the `Client ID` and `Client secret` on the management page of your OAUTH app. .. Note the *Client ID* and *Client secret* on the management page of your OAUTH app.
. In {project_name}, paste the value of the `Client ID` into the *Client ID* field. . In {project_name}, paste the value of the `Client ID` into the *Client ID* field.
. In {project_name}, paste the value of the `Client secret` into the *Client Secret* field. . In {project_name}, paste the value of the `Client secret` into the *Client Secret* field.
. Click *Add*. . Click *Add*.

4
docs/documentation/server_admin/topics/identity-broker/social/gitlab.adoc
View file

@ -3,7 +3,7 @@
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `GitLab`. . From the *Add provider* list, select *GitLab*.
+ +
.Add identity provider .Add identity provider
image:images/gitlab-add-identity-provider.png[Add Identity Provider] image:images/gitlab-add-identity-provider.png[Add Identity Provider]
@ -11,7 +11,7 @@ image:images/gitlab-add-identity-provider.png[Add Identity Provider]
. Copy the value of *Redirect URI* to your clipboard. . Copy the value of *Redirect URI* to your clipboard.
. In a separate browser tab, https://docs.gitlab.com/ee/integration/oauth_provider.html[add a new GitLab application]. . In a separate browser tab, https://docs.gitlab.com/ee/integration/oauth_provider.html[add a new GitLab application].
.. Use the *Redirect URI* in your clipboard as the *Redirect URI*. .. Use the *Redirect URI* in your clipboard as the *Redirect URI*.
.. Note the `Application ID` and `Secret` when you save the application. .. Note the *Application ID* and *Secret* when you save the application.
. In {project_name}, paste the value of the `Application ID` into the *Client ID* field. . In {project_name}, paste the value of the `Application ID` into the *Client ID* field.
. In {project_name}, paste the value of the `Secret` into the *Client Secret* field. . In {project_name}, paste the value of the `Secret` into the *Client Secret* field.
. Click *Add*. . Click *Add*.

8
docs/documentation/server_admin/topics/identity-broker/social/google.adoc
View file

@ -4,7 +4,7 @@
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `Google`. . From the *Add provider* list, select *Google*.
+ +
.Add identity provider .Add identity provider
image:images/google-add-identity-provider.png[Add Identity Provider] image:images/google-add-identity-provider.png[Add Identity Provider]
@ -18,10 +18,10 @@ image:images/google-add-identity-provider.png[Add Identity Provider]
.. From the *Application type* list, select *Web application*. .. From the *Application type* list, select *Web application*.
.. Use the *Redirect URI* in your clipboard as the *Authorized redirect URIs* .. Use the *Redirect URI* in your clipboard as the *Authorized redirect URIs*
.. Click *Create*. .. Click *Create*.
.. Note `Your Client ID` and `Your Client secret`. .. Note *Your Client ID* and *Your Client secret*.
. In {project_name}, paste the value of the `Your Client ID` into the *Client ID* field. . In {project_name}, paste the value of the `Your Client ID` into the *Client ID* field.
. In {project_name}, paste the value of the `Your Client secret` into the *Client Secret* field. . In {project_name}, paste the value of the `Your Client secret` into the *Client Secret* field.
. Click *Add* . Click *Add*
. Enter the required scopes into the *Default Scopes* field. By default, {project_name} uses the following scopes: `openid` `profile` `email`. See the https://developers.google.com/oauthplayground/[OAuth Playground] for a list of Google scopes. . Enter the required scopes into the *Default Scopes* field. By default, {project_name} uses the following scopes: *openid* *profile* *email*. See the https://developers.google.com/oauthplayground/[OAuth Playground] for a list of Google scopes.
. To restrict access to your GSuite organization's members only, enter the G Suite domain into the `Hosted Domain` field. . To restrict access to your GSuite organization's members only, enter the G Suite domain into the *Hosted Domain* field.
. Click *Save*. . Click *Save*.

10
docs/documentation/server_admin/topics/identity-broker/social/instagram.adoc
View file

@ -3,7 +3,7 @@
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `Instagram`. {project_name} displays the configuration page for the Instagram identity provider. . From the *Add provider* list, select *Instagram*.
+ +
.Add identity provider .Add identity provider
image:images/instagram-add-identity-provider.png[Add Identity Provider] image:images/instagram-add-identity-provider.png[Add Identity Provider]
@ -15,12 +15,12 @@ image:images/instagram-add-identity-provider.png[Add Identity Provider]
.Add a use case .Add a use case
image:images/meta-add-use-case.png[Add a use case] image:images/meta-add-use-case.png[Add a use case]
+ +
.. Select `Other`. .. Select *Other*.
+ +
.Select an app type .Select an app type
image:images/meta-select-app-type.png[Select an app type] image:images/meta-select-app-type.png[Select an app type]
+ +
.. Select `Consumer`. .. Select *Consumer*.
+ +
.Create an app .Create an app
image:images/meta-create-app.png[Create an app] image:images/meta-create-app.png[Create an app]
@ -35,7 +35,7 @@ image:images/meta-create-app.png[Create an app]
.Add a product .Add a product
image:images/meta-add-product.png[Add Product] image:images/meta-add-product.png[Add Product]
+ +
.. Select `Dashboard` from the menu. .. Select *Dashboard* from the menu.
.. Click *Set Up* in the *Instagram Basic Display* box. .. Click *Set Up* in the *Instagram Basic Display* box.
.. Click *Create New App*. .. Click *Create New App*.
+ +
@ -51,7 +51,7 @@ image:images/instagram-app-settings.png[Setup the App]
.. Paste the *Redirect URL* from {project_name} into the *Deauthorize Callback URL* field. .. Paste the *Redirect URL* from {project_name} into the *Deauthorize Callback URL* field.
.. Paste the *Redirect URL* from {project_name} into the *Data Deletion Request URL* field. .. Paste the *Redirect URL* from {project_name} into the *Data Deletion Request URL* field.
.. Click *Show* in the *Instagram App Secret* field. .. Click *Show* in the *Instagram App Secret* field.
.. Note the `Instagram App ID` and the `Instagram App Secret`. .. Note the *Instagram App ID* and the *Instagram App Secret*.
.. Click *App Review* - *Requests*. .. Click *App Review* - *Requests*.
.. Follow the instructions on the screen. .. Follow the instructions on the screen.
. In {project_name}, paste the value of the `Instagram App ID` into the *Client ID* field. . In {project_name}, paste the value of the `Instagram App ID` into the *Client ID* field.

4
docs/documentation/server_admin/topics/identity-broker/social/linked-in.adoc
View file

@ -5,7 +5,7 @@
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `LinkedIn`. . From the *Add provider* list, select *LinkedIn*.
+ +
.Add identity provider .Add identity provider
image:images/linked-in-add-identity-provider.png[Add Identity Provider] image:images/linked-in-add-identity-provider.png[Add Identity Provider]
@ -14,7 +14,7 @@ image:images/linked-in-add-identity-provider.png[Add Identity Provider]
. In a separate browser tab, https://developer.linkedin.com[create an app] in the LinkedIn developer portal. . In a separate browser tab, https://developer.linkedin.com[create an app] in the LinkedIn developer portal.
.. After you create the app, click the *Auth* tab. .. After you create the app, click the *Auth* tab.
.. Enter the value of *Redirect URI* into the *Authorized redirect URLs for your app* field. .. Enter the value of *Redirect URI* into the *Authorized redirect URLs for your app* field.
.. Note `Your Client ID` and `Your Client Secret`. .. Note *Your Client ID* and *Your Client Secret*.
.. Click the *Products* tab and *Request access* for the *Sign In with LinkedIn using OpenID Connect* product. .. Click the *Products* tab and *Request access* for the *Sign In with LinkedIn using OpenID Connect* product.
. In {project_name}, paste the value of the `Client ID` into the *Client ID* field. . In {project_name}, paste the value of the `Client ID` into the *Client ID* field.
. In {project_name}, paste the value of the `Client Secret` into the *Client Secret* field. . In {project_name}, paste the value of the `Client Secret` into the *Client Secret* field.

6
docs/documentation/server_admin/topics/identity-broker/social/microsoft.adoc
View file

@ -5,7 +5,7 @@
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `Microsoft`. . From the *Add provider* list, select *Microsoft*.
+ +
.Add identity provider .Add identity provider
image:images/microsoft-add-identity-provider.png[Add Identity Provider] image:images/microsoft-add-identity-provider.png[Add Identity Provider]
@ -15,8 +15,8 @@ image:images/microsoft-add-identity-provider.png[Add Identity Provider]
.. In the Redirect URI section, select *Web* as a platform and paste the value of *Redirect URI* into the field. .. In the Redirect URI section, select *Web* as a platform and paste the value of *Redirect URI* into the field.
.. Find you application under *App registrations* and add a new client secret in the *Certificates & secrets* section. .. Find you application under *App registrations* and add a new client secret in the *Certificates & secrets* section.
.. Note the *Value* of the created secret. .. Note the *Value* of the created secret.
.. Note the `Application (client) ID` in the *Overview* section. .. Note the *Application (client) ID* in the *Overview* section.
. In {project_name}, paste the value of the `Application (client) ID` into the *Client ID* field. . In {project_name}, paste the value of the `Application (client) ID` into the *Client ID* field.
. In {project_name}, paste the *Value* of the secret into the *Client Secret* field. . In {project_name}, paste the `Value` of the secret into the *Client Secret* field.
. Click *Add*. . Click *Add*.

6
docs/documentation/server_admin/topics/identity-broker/social/openshift.adoc
View file

@ -3,7 +3,7 @@
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `Openshift v3`. . From the *Add provider* list, select *Openshift v3*.
+ +
.Add identity provider .Add identity provider
image:images/openshift-add-identity-provider.png[Add Identity Provider] image:images/openshift-add-identity-provider.png[Add Identity Provider]
@ -42,8 +42,8 @@ grantMethod: prompt <4>
. A Keycloak server configured in order to use the truststore. For more information, see the https://www.keycloak.org/server/keycloak-truststore[Configuring a Truststore] {section}. . A Keycloak server configured in order to use the truststore. For more information, see the https://www.keycloak.org/server/keycloak-truststore[Configuring a Truststore] {section}.
.Procedure .Procedure
. Click *Identity Providers* in the {project_name} menu. . Click *Identity Providers* in the menu.
. From the `Social` section, select `Openshift v4` tile. . From the *Add provider* list, select *Openshift v4*.
. Enter the *Client ID* and *Client Secret* and in the *Base URL* field, enter the API URL of your OpenShift 4 instance. Additionally, you can copy the *Redirect URI* to your clipboard. . Enter the *Client ID* and *Client Secret* and in the *Base URL* field, enter the API URL of your OpenShift 4 instance. Additionally, you can copy the *Redirect URI* to your clipboard.
+ +
.Add identity provider .Add identity provider

4
docs/documentation/server_admin/topics/identity-broker/social/paypal.adoc
View file

@ -3,7 +3,7 @@
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `PayPal`. . From the *Add provider* list, select *PayPal*.
+ +
.Add identity provider .Add identity provider
image:images/paypal-add-identity-provider.png[Add Identity Provider] image:images/paypal-add-identity-provider.png[Add Identity Provider]
@ -11,7 +11,7 @@ image:images/paypal-add-identity-provider.png[Add Identity Provider]
. Copy the value of *Redirect URI* to your clipboard. . Copy the value of *Redirect URI* to your clipboard.
. In a separate browser tab, open the https://developer.paypal.com/developer/applications[PayPal Developer applications area]. . In a separate browser tab, open the https://developer.paypal.com/developer/applications[PayPal Developer applications area].
.. Click *Create App* to create a PayPal app. .. Click *Create App* to create a PayPal app.
.. Note the `Client ID` and `Client Secret`. Click the *Show* link to view the secret. .. Note the *Client ID* and *Client Secret*. Click the *Show* link to view the secret.
.. Ensure *Log in with PayPal* is checked. .. Ensure *Log in with PayPal* is checked.
.. Under Log in with PayPal click on *Advanced Settings*. .. Under Log in with PayPal click on *Advanced Settings*.
.. Set the value of the *Return URL* field to the value of *Redirect URI* from {project_name}. Note that the URL can not contain `localhost`. If you want to use {project_name} locally, replace the `localhost` in the *Return URL* by `127.0.0.1` and then access {project_name} using `127.0.0.1` in the browser intead of `localhost`. .. Set the value of the *Return URL* field to the value of *Redirect URI* from {project_name}. Note that the URL can not contain `localhost`. If you want to use {project_name} locally, replace the `localhost` in the *Return URL* by `127.0.0.1` and then access {project_name} using `127.0.0.1` in the browser intead of `localhost`.

4
docs/documentation/server_admin/topics/identity-broker/social/stack-overflow.adoc
View file

@ -5,7 +5,7 @@
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `Stack Overflow`. . From the *Add provider* list, select *Stack Overflow*.
+ +
.Add identity provider .Add identity provider
image:images/stack-overflow-add-identity-provider.png[Add Identity Provider] image:images/stack-overflow-add-identity-provider.png[Add Identity Provider]
@ -22,7 +22,7 @@ image:images/stack-overflow-app-register.png[Register Application]
.Settings .Settings
image:images/stack-overflow-app-settings.png[Settings] image:images/stack-overflow-app-settings.png[Settings]
+ +
. Note the `Client Id`, `Client Secret`, and `Key`. . Note the *Client Id*, *Client Secret*, and *Key*.
. In {project_name}, paste the value of the `Client Id` into the *Client ID* field. . In {project_name}, paste the value of the `Client Id` into the *Client ID* field.
. In {project_name}, paste the value of the `Client Secret` into the *Client Secret* field. . In {project_name}, paste the value of the `Client Secret` into the *Client Secret* field.
. In {project_name}, paste the value of the `Key` into the *Key* field. . In {project_name}, paste the value of the `Key` into the *Key* field.

4
docs/documentation/server_admin/topics/identity-broker/social/twitter.adoc
View file

@ -8,7 +8,7 @@
.Procedure .Procedure
. Click *Identity Providers* in the menu. . Click *Identity Providers* in the menu.
. From the `Add provider` list, select `Twitter`. . From the *Add provider* list, select *Twitter*.
+ +
.Add identity provider .Add identity provider
image:images/twitter-add-identity-provider.png[Add Identity Provider] image:images/twitter-add-identity-provider.png[Add Identity Provider]
@ -16,7 +16,7 @@ image:images/twitter-add-identity-provider.png[Add Identity Provider]
. Copy the value of *Redirect URI* to your clipboard. . Copy the value of *Redirect URI* to your clipboard.
. In a separate browser tab, create an app in https://developer.twitter.com/apps/[Twitter Application Management]. . In a separate browser tab, create an app in https://developer.twitter.com/apps/[Twitter Application Management].
.. Enter App name and click *Next*. .. Enter App name and click *Next*.
.. Note the value of `API Key` and `API Key Secret` and click *App settings*. .. Note the value of *API Key* and *API Key Secret* and click *App settings*.
.. In the *User authentication settings* section click on the *Set up* button. .. In the *User authentication settings* section click on the *Set up* button.
.. Select *Web App* as the *Type of App*. .. Select *Web App* as the *Type of App*.
.. Paste the value of the *Redirect URL* into the *Callback URI / Redirect URL* field. .. Paste the value of the *Redirect URL* into the *Callback URI / Redirect URL* field.