Keycloak OIDC Overview

    ![OIDC keycloak list of clients](/images/sso/keycloak-oidc/clients-list.png)

    <Info>
        You don’t typically need to make a realm dedicated to Infisical. We recommend adding Infisical as a client to your primary realm.
    </Info>

    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)

    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)

    1.4. In the Login Settings step, set the following values:
    - Root URL: `https://app.infisical.com`.
    - Home URL: `https://app.infisical.com`.
    - 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)
    <Info>
        If you’re self-hosting Infisical, then you will want to replace https://app.infisical.com (base URL) with your own domain.
    </Info>

    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)

    1.6. Next, click **Add predefined mapper**.

    ![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)

    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)

</Step>
<Step title="Retrieve Identity Provider (IdP) Information from Keycloak">
    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)

    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)

</Step>
<Step title="Finish configuring OIDC in Infisical">
    3.1. Back in Infisical, head to the **Single Sign-On (SSO)** page and select the **General** tab. Click **Connect** for **OIDC**.
    ![OIDC SSO Connect](../../../../images/sso/connect-oidc.png)

    3.2. For configuration type, select Discovery URL. Then, set the appropriate values for **Discovery Document URL**, **JWT Signature Algorithm**, **Client ID**, and **Client Secret**.
    ![OIDC keycloak paste values into Infisical](/images/sso/keycloak-oidc/create-oidc.png)

    <Info>
        Currently, the following JWT signature algorithms are supported: RS256, RS512, HS256, and EdDSA
    </Info>

    Once you've done that, press **Update** to complete the required configuration.

</Step>
<Step title="Enable OIDC SSO in Infisical">
    Enabling OIDC SSO allows members in your organization to log into Infisical via Keycloak.

    ![OIDC keycloak enable OIDC](/images/sso/enable-oidc.png)

</Step>
<Step title="Enforce OIDC SSO in Infisical">
    Enforcing OIDC SSO ensures that members in your organization can only access Infisical
    by logging into the organization via Keycloak.

    To enforce OIDC SSO, you're required to test out the OpenID connection by successfully authenticating at least one Keycloak user with Infisical.
    Once you've completed this requirement, you can toggle the **Enforce OIDC SSO** button to enforce OIDC SSO.

    <Warning>
        We recommend ensuring that your account is provisioned using the application in Keycloak
        prior to enforcing OIDC SSO to prevent any unintended issues.
    </Warning>
    <Info>
        In case of a lockout, an organization admin can use the [Admin Login Portal](https://infisical.com/docs/documentation/platform/sso/overview#admin-login-portal) in the `/login/admin` path e.g. https://app.infisical.com/login/admin.
    </Info>
</Step>