diff --git a/guides/admin/oidc-okta.md b/guides/admin/oidc-okta.md index e18d9d82d..479d4f275 100644 --- a/guides/admin/oidc-okta.md +++ b/guides/admin/oidc-okta.md @@ -5,43 +5,47 @@ description: Learn how to use Okta SSO with Coder. This article walks you through setting up single sign-on to Coder using Okta. -Configuring [Coder's OpenID Connect](../../admin/access-control/index.md#openid-connect) -feature requires you to provide three pieces of information from Okta: +Configuring [Coder's OpenID +Connect](../../admin/access-control/index.md#openid-connect) feature requires +you to provide three pieces of information from Okta: - Client ID - Client Secret - Issuer -This guide will show you how to set up an app on Okta and obtain the -information you need to provide to Coder. +This guide will show you how to set up an app on Okta and obtain the information +you need to provide to Coder. ## Step 1: Register your app with Okta -1. Log in to your Okta as an admin (`.okta.com`). -1. From the admin dashboard, click **Applications** and click the +1. Log in to your Okta org (`.okta.com`) as an admin. +1. From the admin dashboard, go to **Applications** and select the **Applications** sub-menu. - ![Okta Applications](../../assets/guides/admin/okta-add-app.jpg) - 1. Click **Add Application**. - ![Okta Add Application](../../assets/guides/admin/okta-create-new-app.jpg) + ![Okta Applications](../../assets/guides/admin/okta-add-app.jpg) 1. Click **Create New App**. - ![Okta Create Application Modal](../../assets/guides/admin/okta-custom-app-creation.jpg) + ![Okta Add Application](../../assets/guides/admin/okta-create-new-app.jpg) 1. Select **OpenID Connect** and click **Create** -1. Fill in the **Application name** (i.e. `Coder`), optionally add a logo -1. Add the **Login redirect URIs** for Coder (it will be formatted similar - to `https://coder.my-company.com/oidc/callback`). - - ![Okta Create OpenID Application](../../assets/guides/admin/okta-create-openid-integration.jpg) + + ![Okta Create Application + Modal](../../assets/guides/admin/okta-custom-app-creation.jpg) + +1. Provide an **Application name** (i.e., `Coder`), (optionally) add a logo, and + add the **Login redirect URIs** for Coder (it will be formatted similarly to + `https://coder.my-company.com/oidc/callback`). + + ![Okta Create OpenID + Application](../../assets/guides/admin/okta-create-openid-integration.jpg) 1. Click **Save** to proceed. When Okta has created your app, you'll be redirected to the **General** tab, -which displays the app information. +which displays your app information. ## Step 2: Gather your Okta app information @@ -53,31 +57,30 @@ Once you've saved your app, you can obtain your: ### Client ID and Client Secret -On your application's **General** tab, look for the **Client ID** under -the **Client Credentials** section. Below this is the **Client secret**. +On your application's **General** tab, look for the **Client Credentials** +section, which includes the **Client secret**. ![Client ID and Secret](../../assets/guides/admin/okta-client-id-and-secret.jpg) ### Issuer -On your app's **Overview** page, click the **Sign On** tab. Find the -**OpenID Connect ID Token** section, and copy the **Issuer**. +On your app's **Overview** page, click the **Sign On** tab. Find the **OpenID +Connect ID Token** section, and copy the **Issuer**. ![Issuer](../../assets/guides/admin/okta-issuer.jpg) -## Step 3: Assign People and/or Groups to Coder +## Step 3: Assign People and Groups to Coder -On your app's **Overview** page, click the **Assignments** tab. +On your app's **Overview** page, click the **Assignments** tab. Under +**Assign**, you can choose to **Assign to People** or **Assign to Group** to +provide users and groups access to Coder. ![Assignments](../../assets/guides/admin/okta-assign-app.jpg) -From here, you can assign People and Groups to the application to -provide access to Coder. - ## Step 4: Configure Coder authentication -Once you've saved your Okta values, you can complete the remaining steps using the -Coder UI. +Once you've saved your Okta values, you can complete the remaining steps using +the Coder UI. 1. Log in to Coder, and go to **Manage** > **Admin** > **Authentication**. 1. In the top-most drop-down box, select **OpenID Connect**. @@ -87,4 +90,4 @@ Coder UI. When done, click **Save Preferences**. At this point, Coder validates your configuration before proceeding. If -successful, you can expect Coder to send OIDC login attempts to Okta. +successful, Coder will send OIDC login attempts to Okta.