diff --git a/src/docs.json b/src/docs.json index 70e57878..7e7eb6e2 100644 --- a/src/docs.json +++ b/src/docs.json @@ -183,6 +183,7 @@ "provider-guides/netsuite", "provider-guides/notion", "provider-guides/nutshell", + "provider-guides/okta", "provider-guides/openAI", "provider-guides/outplay", "provider-guides/outreach", diff --git a/src/generate-docs.ts b/src/generate-docs.ts index 5cf22a64..0f877baf 100644 --- a/src/generate-docs.ts +++ b/src/generate-docs.ts @@ -395,6 +395,7 @@ const baseConfig = { "provider-guides/netsuite", "provider-guides/notion", "provider-guides/nutshell", + "provider-guides/okta", "provider-guides/openAI", "provider-guides/outplay", "provider-guides/outreach", diff --git a/src/images/provider-guides/okta1.gif b/src/images/provider-guides/okta1.gif new file mode 100644 index 00000000..edae0316 Binary files /dev/null and b/src/images/provider-guides/okta1.gif differ diff --git a/src/images/provider-guides/okta2.gif b/src/images/provider-guides/okta2.gif new file mode 100644 index 00000000..a80b0233 Binary files /dev/null and b/src/images/provider-guides/okta2.gif differ diff --git a/src/provider-guides/okta.mdx b/src/provider-guides/okta.mdx new file mode 100644 index 00000000..45448635 --- /dev/null +++ b/src/provider-guides/okta.mdx @@ -0,0 +1,67 @@ +--- +title: Okta +--- +## What's supported + +### Supported actions + +This connector supports: +- [Proxy Actions](/proxy-actions), using the base URL `https://{{.workspace}}.okta.com`. + +## Before you get started + +To connect Okta with Ampersand, you will need an [Okta account](https://developer.okta.com/signup/). + +Once your account is created, you'll need to create an OAuth 2.0 app in Okta and obtain the following credentials: + +- Client ID +- Client Secret +- Scopes + +You will use these credentials to connect your application to Ampersand. + +### Create an Okta account + +Here's how you can sign up for an Okta developer account: + +1. Go to the [Okta Developer Sign Up page](https://developer.okta.com/signup/) and create an account. +2. Complete the registration process and verify your email. + +### Creating an Okta app + +Follow the steps below to create an OAuth 2.0 app in Okta: + +1. Sign in to your [Okta Admin Console](https://login.okta.com/). +2. Navigate to **Applications** > **Applications** in the left sidebar. +3. Click **Create App Integration**. +4. Select **OIDC - OpenID Connect** as the sign-in method. +5. Select **Web Application** as the application type and click **Next**. +6. Enter a descriptive **App integration name**. +7. In the **Sign-in redirect URIs** field, enter the Ampersand redirect URL: `https://api.withampersand.com/callbacks/v1/oauth` +8. Click **Save**. + +The **Client ID** and **Client Secret** will be displayed in the **Client Credentials** section. Note these credentials, as you will need them to connect your app to Ampersand. + +To configure scopes, navigate to the **Okta API Scopes** tab and click **Grant** next to each scope your integration requires. + +![Okta App Creation](/images/provider-guides/okta1.gif) + +## Add your Okta app info to Ampersand + +1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com). + +2. Select the project where you want to create an Okta integration. + + ![Ampersand project selection](/images/provider-guides/dd47b7a-Ampersand.png) + +3. Select **Provider Apps**. + +4. Select _Okta_ from the **Provider** list. + +5. Enter the previously obtained **Client ID** in the **Client ID** field and the **Client Secret** in the **Client Secret** field. + +6. Enter the scopes set for your application in _Okta_. For a list of available scopes, refer to the [Okta documentation](https://developer.okta.com/docs/guides/implement-oauth-for-okta/main/#scopes-and-supported-endpoints). + + ![Okta Ampersand integration](/images/provider-guides/okta2.gif) + +7. Click **Save Changes**.