Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/@okta/vuepress-site/conductor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6055,3 +6055,5 @@ redirects:
to: /docs/concepts/universal-directory/
- from: /docs/concepts/user-profiles/index.html
to: /docs/concepts/universal-directory/
- from: /docs/guides/submit-app/apiservice/main/
to: /docs/guides/submit-oin-app/uapiservice/main/
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ app -> client: Response

2. If the credentials in the token request are accurate, Okta responds with an access token.

You set the resource and action scopes allowed for the access token when you [register your API service integration](#register-your-api-service-integration) through the OIN Manager. The token request must contain allowed scopes for your API service integration. See [Scope selection](#scope-selection).
You set the resource and action scopes allowed for the access token when you [register your API service integration](#register-your-api-service-integration) through the OIN Wizard. The token request must contain allowed scopes for your API service integration. See [Scope selection](#scope-selection).

3. Your customer's service app instance uses the access token to make authorized requests to their Okta org APIs (the resource server). See [Make Okta API requests](#make-okta-api-requests).

Expand Down Expand Up @@ -101,39 +101,31 @@ The [org authorization server](/docs/concepts/auth-servers/#org-authorization-se

### Register your API service integration

The OIN Manager provides a mechanism to register and install your integration in your Okta org (similar to how your customer admins would install your integration) and obtain the credentials to test your Client Credentials flow. Your test integration is available only on your Okta org during the test.
The OIN Wizard provides a mechanism to register and install your integration in your Okta org (similar to how your customer admins would install your integration) and obtain the credentials to test your Client Credentials flow. Your test integration is available only on your Okta org during the test.

> **Note:** From the OIN Manager test option, the test install and authorize pages are the same pages that your customers experience when your service integration is in the OIN. After you publish your integration in the OIN catalog, it appears in the **Applications** > **API Service Integrations** page of your customer's Admin Console.
> **Note:** From the OIN Wizard test option, the test install and authorize pages are the same pages that your customers experience when your service integration is in the OIN. After you publish your integration in the OIN catalog, it appears in the **Applications** > **API Service Integrations** page of your customer's Admin Console.

To register your API service registration:

1. Go to the [OIN Manager](https://oinmanager.okta.com/) and click **Start Submission Form**.
1. Sign in with the credentials of the Okta org you used to build your integration (this is typically your Okta Integrator Free Plan org).
1. Click **Add New Submission**.
1. On the **General Settings** tab, specify values in the **App Information**, **Customer Support**, and **Test Account** sections. See [Configure general settings](/docs/guides/submit-app/apiservice/main/#configure-general-settings) for field descriptions.
1. On the **API Service** tab, select **On** from the **API Service support** dropdown menu.

The **API Service Settings** appear, and the **Client Credentials** grant type is selected. This is the only supported grant type for OAuth 2.0 API service integrations.
1. Under **Enable scopes**, click **+ Add Another** to specify a scope for your app integration.

* Enter the Okta API scope to grant access from your integration. See [Scope selection](#scope-selection).
* Click **+ Add Another** and specify more scopes you want to grant for your integration.

1. Specify the URL to the configuration document for your integration under **Link to configuration guide**. See [Customer configuration document guidelines](/docs/guides/submit-app-prereq/main/#customer-configuration-document-guidelines).
To register your API service registration, see [Submit an integration with the OIN Wizard](https://developer.okta.com/docs/guides/submit-oin-app/openidconnect/main/).

### Authorize a test integration

Use the test functionality in the OIN Manager to obtain test integration credentials:

1. From the [OIN Manager](https://oinmanager.okta.com/), click **Edit** next to your API service integration submission.
1. From the **API Service** tab, click **Test in Okta** at the bottom of your page.

Your browser redirects to the Authorize integration page in your Okta org.

1. From the Authorize integration page, click **Install and Authorize**.
1. Copy the client secret from the dialog and securely store it for your integration test.
1. Click **Done** to dismiss the dialog.
1. On the integration details page, copy the Okta domain and client ID and securely store them for your integration test.
Use the test functionality in the OIN Wizard to obtain test integration credentials:

1. In the OIN Wizard, click **Applications** > **Your OIN Integrations**.
1. Cick the more icon (![three-dot more icon](/img/icons/odyssey/more.svg)) next to the integration submission that you want to test and click **Test integration**.
1. Click **Generate instance**. The **Authorize integration** page appears.
1. Go to **Test integration** > **Generate instance**. The **Authorize integration** page appears.
1. Click **Install & Authorize**.
1. Copy the client secret from the dialog and store it securely.
>**Note**: For security purposes, the client secret is only displayed once and can't be retrieved later.
1. Click **Done**.
1. On the **General** tab, copy the **Okta domain** and **client ID** and securely store them for your integration test.
1. Configure your app using the Okta domain, client ID, and client secret.
1. Perform manual testing to verify your integration.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reference the other test sections???

1. Once the testing is complete, click **Continue to submission**. The **Test integration** page appears.
1. Enable the **Test account requirements** and **API service requirements** checkboxes.
1. Select the **I certify that I have successfully completed required tests** checkbox to confirm that the required tests are complete.
1. Click **Submit integration**.

For testing purposes, use the Okta domain, client ID, and client secret obtained from your test integration to make an access token request. Then, make an API request using the access token returned by the first request. See [Test your API service flow](#test-your-api-service-flow).

Expand Down Expand Up @@ -220,35 +212,22 @@ After you complete testing and are satisfied with your API service integration,

To edit your API service integration submission fields:

1. From the [OIN Manager](https://oinmanager.okta.com/), click **Edit** next to your integration submission.
1. In the OIN Wizard, click **Applications** > **Your OIN integrations**.
1. Select an integration from the list. Click **Edit** next to your integration submission.
1. Edit the fields that you want to modify.

The OIN Manager saves the values in the fields automatically.

If the fields that you update affect the test integration instance in your Okta org (such as integration name or scopes), then you must click **Test in Okta** to create another test integration instance with the updated fields. The test integration instance is a static snapshot of your integration submission fields at the time that it was created. It doesn't get updated when you modify your submission. If you want to remove older test integration instances that aren't used, see [Remove your test integration instance](#remove-your-test-integration-instance).
f the fields that you update affect the test integration instance in your Okta org (such as integration name or scopes), click **Generate instance** to create another test integration instance with the updated fields. The test integration instance is a static snapshot of your integration submission fields at the time that it was created. It isn't updated when you modify your submission. If you want to remove older test integration instances that aren't used, see [Remove your test integration instance](#remove-your-test-integration-instance).

### Remove your test integration instance

To remove a test API service integration in your Okta org, click **Revoke** from the integration details page in your Admin Console. This action revokes the scope grants, client ID, and secret from the test integration installed previously.

You can click **Test in Okta** again from the OIN Manager to install another test integration instance in your Okta org. This action is useful when you update your submission in the OIN Manager (for example, modifying the scopes or name of the integration) and want to see the updates reflected in the test integration instance.
Click **Generate instance** to generate another test integration instance in your Okta org. This action is useful when you update your submission in the OIN Wizard (for example, modifying the scopes or name of the integration) and want to see the updates reflected in the test integration instance.

### Submit for review

After you test your API service integration and specify all fields and artifacts in the OIN Manager, you can submit your integration to Okta.

1. Sign in to [OIN Manager](https://oinmanager.okta.com/) and click **Edit** next to your API service integration submission.
1. From the **API Service** tab, click **Submit for Review** on the right side of your page.

A dialog appears and displays the completed submission tabs.

> **Note:** The **Submit for Review** option isn't available if there are missing required fields in the submission.

1. Click **Submit for Review** from the dialog to confirm the submission.

The system notifies the Okta OIN team, and your submission goes through a series of testing and verification processes. The OIN team emails you for required updates and corrections. The OIN Manager also displays the latest status of your submission.
After you test your API service integration and specify all fields and artifacts in the OIN Wizard, you can submit your integration to Okta. See, [Submit your integration section](/docs/guides/submit-oin-app/openidconnect/main/#submit-your-integration).

When your integration reaches the Publish stage, your integration is available on the OIN catalog and your customers can see an option to install it from their Okta org.

## Support

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,4 @@ Ready to get started? Choose how you want to implement your lifecycle management
</Cards>
<br>

After your Okta lifecycle management integration is built and tested, [submit](/docs/guides/submit-oin-app/scim/main/) it through the OIN Manager and the Okta OIN team will verify it.
After your Okta lifecycle management integration is built and tested, [submit](/docs/guides/submit-oin-app/scim/main/) it through the OIN Wizard and the Okta OIN team will verify it.
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ To get started using Runscope to test your SCIM API:
1. If you're new to Runscope, your dashboard displays sample Runscope tutorials. Click **Skip Tutorial**. A page titled **API Tests** appears.
1. In the lower left of your page, click **Import Test**. A new page appears, titled **Import Tests into &#x2026;**.
1. Select **API Monitoring Tests** as the import format.
1. Click **Choose File** and select the JSON file that you saved in step 1.
1. Click **Choose File**, and then select the JSON file that you saved in step 1.
1. Click **Import API Test**.
1. After the import is finished, click **All Tests** on the left of your page.

Expand Down Expand Up @@ -253,7 +253,7 @@ Since this test is running in your own Runscope instance, you can modify the tes

As you refine your SCIM implementation, you can share API test results with your teammates or with people outside of your organization:

1. From your Runscope dashboard, open the test results that you want to share.
1. In your Runscope dashboard, open the test results that you want to share.
2. At the top of the test result, change the **Private | Shareable** toggle from **Private** to **Shareable**.
3. Copy the URL for the test result, it looks something like this:
`https://www.runscope.com/radar/abcdefghijkl/m01nopq2-3456-7r8s-9012-t34567uvw890/history/123ef4gh-i567-89j0-1k2l-3m4n5o678901`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ To configure and run the SCIM CRUD tests:
* If you're using SCIM 1.1, download: [Okta SCIM 1.1 CRUD test file](/standards/SCIM/SCIMFiles/Okta-SCIM-11-CRUD-Test.json)
1. Click **Import Test** in Runscope.
1. Select **API Monitoring Tests** as the import format.
1. Click **Choose File** and select the Okta SCIM 2.0 CRUD JSON test file.
1. Click **Import API Test**. In this new test bucket, click **Editor** from the left-navigation menu.
1. Click **Test Settings** and then click **Initial Variables**.
1. Click **Choose File**, and then select the Okta SCIM 2.0 CRUD JSON test file.
1. Click **Import API Test**. In the new test bucket, click **Editor** from the left-navigation menu.
1. Click **Test Settings**, and then click **Initial Variables**.
1. Add the following variables with values that match your SCIM integration:
* `oktaAppId`: The unique identifier that's randomly assigned to your Okta integration. You can see this value in the **App Embed Link** panel under the **General** tab for your Okta integration.
* `oktaOrgUrl`: The base URL for your Okta org. Include the `https://` prefix.
Expand All @@ -79,7 +79,7 @@ To configure and run the SCIM CRUD tests:

</div>

1. Click **Test Settings** and then click **Initial Script**.
1. Click **Test Settings**, and then click **Initial Script**.
1. Copy the contents of the [Okta CRUD Initial Script](/standards/SCIM/SCIMFiles/Initial_Script_CRUD.txt) text file and paste into this Runscope console.
1. Click **Save & Run**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ If you're an integrator, from an independent software vendor (ISV) or an existin

## Submission process

Okta introduced a seamless experience to submit SSO and SCIM integrations for OIN publication. This experience enables you to build and test your integration before submission directly from the Admin Console with the [OIN Wizard](/docs/guides/submit-oin-app/). This reduces the tools that you need to build, test, and submit your integration. Moreover, it reduces the time needed for the OIN team to review and validate your integration, which shortens the time to publish in the OIN.
Okta introduced a seamless experience to submit SSO, SCIM, and API service integrations for OIN publication. This experience enables you to build and test your integration before submission directly from the Admin Console with the [OIN Wizard](/docs/guides/submit-oin-app/). This reduces the tools that you need to build, test, and submit your integration. Moreover, it reduces the time needed for the OIN team to review and validate your integration, which shortens the time to publish in the OIN.

You can also submit updates to a previously published SSO or SCIM integration in the OIN Wizard.
You can also submit updates to a previously published SSO. SCIM, or API service integration in the OIN Wizard.

For Workflows connector or API service integrations, you need to use the [OIN Manager](https://oinmanager.okta.com/) for submission.
For Workflows connector integrations, you need to use the [OIN Manager](https://oinmanager.okta.com/) for submission.

> **Note:** Okta recommends that you:
> * Separate environments for development, testing, and production.
Expand All @@ -29,21 +29,19 @@ Before you submit your integration, in either the OIN Wizard or OIN Manager, rev

Consider the following questions to help you choose which pathway to use for submission:

* Are you submitting a new or published SSO or SCIM integrations?
* Are you submitting a new or published SSO, SCIM, or API service integrations?
* [Use the OIN Wizard](#submission-process-for-sso-and-scim-integrations).
> **Note:** Published SSO or SCIM integrations that were submitted through the OIN Manager have been moved to the OIN Wizard and appear in the **Your OIN Integrations** dashboard.
* Are you submitting a new or published Workflows integration?
* [Use the OIN Manager for Workflows integrations](#submission-process-for-workflows-integrations).
* Are you submitting a new or published API service integration?
* [Use the OIN Manager for API services](#submission-process-for-api-service-integrations).

Submit your integration to Okta and work with the OIN team as they test and review your submission. If the OIN team identifies any issues in the review and QA testing phases, you're sent an email with the specific details. At any point in the process, you can check the status of your submission in the OIN Wizard or OIN Manager.

The Okta OIN team reviews and prioritizes all submissions.

### Submission process for SSO and SCIM integrations
### Submission process for SSO, SCIM, and API service integrations

The following steps outline the process for submitting SSO and SCIM integrations through the OIN Wizard.
The following steps outline the process for submitting SSO, SCIM, and API service integrations through the OIN Wizard.

1. Build the integration in your app.
1. Sign in to the Admin Console of your Integrator Free Plan org.
Expand All @@ -66,21 +64,6 @@ Source link : https://www.figma.com/file/YH5Zhzp66kGCglrXQUag2E/%F0%9F%93%8A-Upd

</div>

### Submission process for API service integrations

The following steps outline the submission process for API service integrations with the OIN Manager:

1. Build the integration in your service app.
1. Sign in to the OIN Manager with your Integrator Free Plan org credentials.
- Add integration details in the OIN Manager.
- Generate the app integration instance.
- Test the integration.
- Submit the integration.
1. Review feedback.
- After submission, the OIN team reviews your integration. See [Understand the submission review process](#understand-the-submission-review-process).
1. Publish to OIN catalog.
- The OIN team publishes your integration after they verify that your integration works as intended for your Okta customers.

### Submission process for Workflows integrations

The following steps and flowchart explain how to submit Workflows integrations through the OIN Manager:
Expand Down Expand Up @@ -177,6 +160,6 @@ Ready to make your integration public? Submit an integration with the following

<Card href="/docs/guides/submit-oin-app/scim/main/" headerImage="/img/icons/scim.svg" cardTitle="SCIM" :showFooter=false>Submit a SCIM integration</Card>

<Card href="/docs/guides/submit-app/apiservice/main/" headerImage="/img/icons/odyssey/APIs.svg" cardTitle="API service" :showFooter=false>Submit an API service integration</Card>
<Card href="/docs/guides/build-api-integration/main/" headerImage="/img/icons/odyssey/APIs.svg" cardTitle="API service" :showFooter=false>Submit an API service integration</Card>

</Cards>
Loading