diff --git a/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/auth0.md b/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/auth0.md index 007f853d91..752e188ab9 100644 --- a/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/auth0.md +++ b/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/auth0.md @@ -39,13 +39,20 @@ To configure Appsmith to use [Auth0](https://auth0.com/) as an OIDC provider, fo 2. In the **Create application** modal, select **Regular Web Application** and click **Create**. -3. Once your application is created, you're taken to the Quick Start screen. Go to the **Settings** tab. +3. In the Integration screen, click Skip, then open the Application **Settings** tab. + + +
+ + + +
4. In the basic information section, copy the **Client ID** and **Client Secret** to add them later in the OIDC configurations in Appsmith. 5. Scroll down to the **Application URIs** and paste the **Redirect URL** copied from the OIDC configuration in Appsmith in the **Allowed Callback URLs** field. -6. On the **Settings** tab, go to **Advanced Settings > Endpoints**. Copy the following URls from the OAuth section to add them later in the OIDC configurations in Appsmith: +6. In the **Settings** tab, navigate to **Advanced Settings** > **Endpoints**. Copy the following URLs from the OAuth section to use later in your OIDC configuration in Appsmith:
@@ -57,6 +64,9 @@ To configure Appsmith to use [Auth0](https://auth0.com/) as an OIDC provider, fo - **JSON Web Key Set** + + +
6. Click **Save Changes**. @@ -90,7 +100,7 @@ To complete the OIDC configuration, you must register the identity provider on A 4. In the **Username Attribute** box, specify the name of the claim which represents the email of the user. The default value is `email`. -Once you have added the details, click the **SAVE & RESTART** button to save the configuration and restart the instance. +5. Once you have added the details, click the **SAVE & RESTART** button to save the configuration and restart the instance. :::info If you're running Appsmith on a **Kubernetes** cluster with an HA configuration, after completing the setup, run the following command to ensure the new authentication settings are properly applied: diff --git a/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/entra-id.md b/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/entra-id.md index a4507b7273..d1fc017110 100644 --- a/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/entra-id.md +++ b/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/entra-id.md @@ -152,7 +152,7 @@ To complete the OIDC configuration, you have to register the identity provider o 5. In the **Username Attribute** box, specify the name of the claim as `sub` that uniquely identifies the user. -Once you have added the details, click the **SAVE & RESTART** button to save the configuration and restart the instance. +6. Once you have added the details, click the **SAVE & RESTART** button to save the configuration and restart the instance. :::info If you're running Appsmith on a **Kubernetes** cluster with an HA configuration, after completing the setup, run the following command to ensure the new authentication settings are properly applied: diff --git a/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/fusionauth.md b/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/fusionauth.md index ecc3c6560c..a7952b082f 100644 --- a/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/fusionauth.md +++ b/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/fusionauth.md @@ -116,7 +116,7 @@ To complete the OIDC configuration, you have to register the identity provider o 4. In the **Username Attribute** box, specify the name of the claim which represents the email of the user. The default value is `email`. -Once you have added the details, click the **SAVE & RESTART** button to save the configuration and restart the instance. +5. Once you have added the details, click the **SAVE & RESTART** button to save the configuration and restart the instance. :::info If you're running Appsmith on a **Kubernetes** cluster with an HA configuration, after completing the setup, run the following command to ensure the new authentication settings are properly applied: diff --git a/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/okta.md b/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/okta.md index d526f7fa26..1c2b486492 100644 --- a/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/okta.md +++ b/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/okta.md @@ -41,14 +41,17 @@ To configure Appsmith to use [Okta](https://www.okta.com/) as an OIDC provider, 1. Log in to your [Okta](https://www.okta.com/) account and click **Admin** from the top right corner. -2. On the **Get started with Okta** page, click **Add App** for **Use single sign on**. +2. Select **Create a new app integration** and configure as follows: -3. On the **Browse App Integration Catalog** page, click **Create New App**. +
-4. A pop-up titled **Create a new app integration** appears. Choose **OIDC - OpenID Connect** as the Sign-in method and select Application type as **Web Application**. +- **Sign-in method:** OIDC - OpenID Connect -5. On the **New Web App Integration** page, go to the general settings: +- **Application type:** Web Application +
+ +5. On the **New Web App Integration** page, go to the general settings:
@@ -66,12 +69,34 @@ To configure Appsmith to use [Okta](https://www.okta.com/) as an OIDC provider, 6. On your new application, go to the **General** tab, and copy the **Client ID** and **Client Secret** to add them later in the OIDC configurations in Appsmith. -7. Open your account dropdown from the navigation bar, and copy your **Okta domain** that is mentioned below your Email. +
+ + + + +
+ + + -8. Add `/.well-known/openid-configuration` at the end of your **Okta domain**, and open the `/.well-known/openid-configuration` URL in your browser and copy the following URLs from that page: +7. Open your account dropdown from the top-right corner of the navigation bar, and copy your **Okta domain** that is mentioned below your Email.
+ + + +
+ +8. Open your Okta domain URL in your browser, add `/.well-known/openid-configuration` to the end, like: + +
+ +```js +https://your-okta-domain.okta.com/.well-known/openid-configuration +``` + +Copy the following URLs from the page: - **authorization_endpoint** @@ -81,9 +106,12 @@ To configure Appsmith to use [Okta](https://www.okta.com/) as an OIDC provider, - **jwks_uri** +
+ + ## Register Okta in Appsmith To complete the OIDC configuration, you have to register the identity provider on Appsmith. Go to **Admin Settings > Authentication > OIDC**, and follow the steps below: @@ -117,7 +145,7 @@ To complete the OIDC configuration, you have to register the identity provider o 4. In the **Username Attribute** box, specify the name of the claim which represents the email of the user. The default value is `email`. -Once you have added the details, click the **SAVE & RESTART** button to save the configuration and restart the instance. +5. Once you have added the details, click the **SAVE & RESTART** button to save the configuration and restart the instance. :::info If you're running Appsmith on a **Kubernetes** cluster with an HA configuration, after completing the setup, run the following command to ensure the new authentication settings are properly applied: diff --git a/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/ping-identity.md b/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/ping-identity.md index f63a8a3a43..63fb72bea0 100644 --- a/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/ping-identity.md +++ b/website/docs/getting-started/setup/instance-configuration/authentication/openid-connect-oidc/ping-identity.md @@ -53,13 +53,16 @@ To configure Appsmith to use [Ping Identity](https://www.pingidentity.com/en.htm b. Click **Next**. - c. Enter the environment name and description. Click **Next**. + c. Enter the Environment name, description, Environment type, region, and license. Then click **Finish**. -3. Open the newly created Environment, and from the sidebar, go to **Connections** > **Applications**. -4. On the Applications homepage, click the **+** icon to create a new application. On the **Add Application** panel: +3. Open the newly created environment and click **Manage Environment**. + +4. From the sidebar, go to **Connections > Applications.** + +5. On the Applications homepage, click the **+** icon to create a new application. On the **Add Application** panel:
@@ -75,7 +78,18 @@ To configure Appsmith to use [Ping Identity](https://www.pingidentity.com/en.htm a. Click the edit ✏️ icon, and check the **Refresh Token** option. This allows Ping Identity to issue refresh tokens to Appsmith for refreshing access tokens when they expire. - b. Copy the following URLs from the **URLs** dropdown to add them later in the OIDC configurations in Appsmith: + b. Add the **Redirect URL** from the OIDC configurations in Appsmith into the **Redirect URI** field. + +
+ + + + +
+ + + + c. Copy the following URLs from the **URLs** dropdown to add them later in the OIDC configurations in Appsmith:
@@ -117,7 +131,7 @@ To complete the OIDC configuration, you have to register the identity provider o 4. In the **Username Attribute** box, specify the name of the claim which represents the email of the user. The default value is `email`. -Once you have added the details, click the **SAVE & RESTART** button to save the configuration and restart the instance. +5. Once you have added the details, click the **SAVE & RESTART** button to save the configuration and restart the instance. :::info If you're running Appsmith on a **Kubernetes** cluster with an HA configuration, after completing the setup, run the following command to ensure the new authentication settings are properly applied: diff --git a/website/static/img/auth-oidc-app.png b/website/static/img/auth-oidc-app.png new file mode 100644 index 0000000000..a75d26a4cd Binary files /dev/null and b/website/static/img/auth-oidc-app.png differ diff --git a/website/static/img/auto-oidc-endpoints.png b/website/static/img/auto-oidc-endpoints.png new file mode 100644 index 0000000000..1d47672ea1 Binary files /dev/null and b/website/static/img/auto-oidc-endpoints.png differ diff --git a/website/static/img/oidc-okta-url.png b/website/static/img/oidc-okta-url.png new file mode 100644 index 0000000000..a996163684 Binary files /dev/null and b/website/static/img/oidc-okta-url.png differ diff --git a/website/static/img/okta-id-oidc.png b/website/static/img/okta-id-oidc.png new file mode 100644 index 0000000000..f308e90476 Binary files /dev/null and b/website/static/img/okta-id-oidc.png differ diff --git a/website/static/img/ping-odic-uri.png b/website/static/img/ping-odic-uri.png new file mode 100644 index 0000000000..fe4fe63825 Binary files /dev/null and b/website/static/img/ping-odic-uri.png differ