diff --git a/docs/documentation/platform/sso/keycloak-oidc/overview.mdx b/docs/documentation/platform/sso/keycloak-oidc/overview.mdx index 3b7df8990..4f5bc689e 100644 --- a/docs/documentation/platform/sso/keycloak-oidc/overview.mdx +++ b/docs/documentation/platform/sso/keycloak-oidc/overview.mdx @@ -15,7 +15,7 @@ description: "Learn how to configure Keycloak OIDC for Infisical SSO." 1.1. In your realm, navigate to the **Clients** tab and click **Create client** to create a new client application. - ![OIDC keycloak list of clients](../../../images/sso/keycloak-oidc/clients-list.png) + ![OIDC keycloak list of clients](/images/sso/keycloak-oidc/clients-list.png) You don’t typically need to make a realm dedicated to Infisical. We recommend adding Infisical as a client to your primary realm. @@ -23,11 +23,11 @@ description: "Learn how to configure Keycloak OIDC for Infisical SSO." 1.2. In the General Settings step, set **Client type** to **OpenID Connect**, the **Client ID** field to an appropriate identifier, and the **Name** field to a friendly name like **Infisical**. - ![OIDC keycloak create client general settings](../../../images/sso/keycloak-oidc/create-client-general-settings.png) + ![OIDC keycloak create client general settings](/images/sso/keycloak-oidc/create-client-general-settings.png) 1.3. Next, in the Capability Config step, ensure that **Client Authentication** is set to On and that **Standard flow** is enabled in the Authentication flow section. - ![OIDC keycloak create client capability config settings](../../../images/sso/keycloak-oidc/create-client-capability.png) + ![OIDC keycloak create client capability config settings](/images/sso/keycloak-oidc/create-client-capability.png) 1.4. In the Login Settings step, set the following values: - Root URL: `https://app.infisical.com`. @@ -35,42 +35,42 @@ description: "Learn how to configure Keycloak OIDC for Infisical SSO." - Valid Redirect URIs: `https://app.infisical.com/api/v1/sso/oidc/callback`. - Web origins: `https://app.infisical.com`. - ![OIDC keycloak create client login settings](../../../images/sso/keycloak-oidc/create-client-login-settings.png) + ![OIDC keycloak create client login settings](/images/sso/keycloak-oidc/create-client-login-settings.png) If you’re self-hosting Infisical, then you will want to replace https://app.infisical.com (base URL) with your own domain. 1.5. Next, navigate to the **Client scopes** tab and select the client's dedicated scope. - ![OIDC keycloak client scopes list](../../../images/sso/keycloak-oidc/client-scope-list.png) + ![OIDC keycloak client scopes list](/images/sso/keycloak-oidc/client-scope-list.png) 1.6. Next, click **Add predefined mapper**. - ![OIDC keycloak client mappers empty](../../../images/sso/keycloak-oidc/client-scope-mapper-menu.png) + ![OIDC keycloak client mappers empty](/images/sso/keycloak-oidc/client-scope-mapper-menu.png) 1.7. Select the **email**, **given name**, **family name** attributes and click **Add**. - ![OIDC keycloak client mappers predefined 1](../../../images/sso/keycloak-oidc/scope-predefined-mapper-1.png) - ![OIDC keycloak client mappers predefined 2](../../../images/sso/keycloak-oidc/scope-predefined-mapper-2.png) + ![OIDC keycloak client mappers predefined 1](/images/sso/keycloak-oidc/scope-predefined-mapper-1.png) + ![OIDC keycloak client mappers predefined 2](/images/sso/keycloak-oidc/scope-predefined-mapper-2.png) Once you've completed the above steps, the list of mappers should look like the following: - ![OIDC keycloak client mappers completed](../../../images/sso/keycloak-oidc/client-scope-complete-overview.png) + ![OIDC keycloak client mappers completed](/images/sso/keycloak-oidc/client-scope-complete-overview.png) 2.1. Back in Keycloak, navigate to Configure > Realm settings > General tab > Endpoints > OpenID Endpoint Configuration and copy the opened URL. This is what is to referred to as the Discovery Document URL and it takes the form: `https://keycloak-mysite.com/realms/myrealm/.well-known/openid-configuration`. - ![OIDC keycloak realm OIDC metadata](../../../images/sso/keycloak-oidc/realm-setting-oidc-config.png) + ![OIDC keycloak realm OIDC metadata](/images/sso/keycloak-oidc/realm-setting-oidc-config.png) 2.2. From the Clients page, navigate to the Credential tab and copy the **Client Secret** to be used in the next steps. - ![OIDC keycloak realm OIDC secret](../../../images/sso/keycloak-oidc/client-secret.png) + ![OIDC keycloak realm OIDC secret](/images/sso/keycloak-oidc/client-secret.png) 3.1. Back in Infisical, in the Organization settings > Security > OIDC, click Connect. - ![OIDC keycloak manage org Infisical](../../../images/sso/keycloak-oidc/manage-org-oidc.png) + ![OIDC keycloak manage org Infisical](/images/sso/keycloak-oidc/manage-org-oidc.png) 3.2. For configuration type, select Discovery URL. Then, set the appropriate values for **Discovery Document URL**, **Client ID**, and **Client Secret**. - ![OIDC keycloak paste values into Infisical](../../../images/sso/keycloak-oidc/create-oidc.png) + ![OIDC keycloak paste values into Infisical](/images/sso/keycloak-oidc/create-oidc.png) Once you've done that, press **Update** to complete the required configuration. @@ -78,7 +78,7 @@ description: "Learn how to configure Keycloak OIDC for Infisical SSO." Enabling OIDC SSO allows members in your organization to log into Infisical via Keycloak. - ![OIDC keycloak enable OIDC](../../../images/sso/keycloak-oidc/enable-oidc.png) + ![OIDC keycloak enable OIDC](/images/sso/keycloak-oidc/enable-oidc.png)