Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OKTA-829814 Add new topic for Update an integration in the OIN Wizard #5302

Open
wants to merge 28 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
f6079a8
Add new slack selector topic for Update an integration
vanngo-okta Jan 30, 2025
9aafcec
Move update considerations and update steps over
vanngo-okta Jan 30, 2025
196dd11
More edits with update an integration
vanngo-okta Jan 30, 2025
4577c9b
Edit submit update section
vanngo-okta Feb 3, 2025
fd29537
Add new snippet for detecting old instances
vanngo-okta Feb 4, 2025
e26c819
More snippets and edits to support updating integration.
vanngo-okta Feb 6, 2025
e2ae519
More edits to test integration snippets
vanngo-okta Feb 6, 2025
a1808ae
Edits to test step and required app instance snippets
vanngo-okta Feb 7, 2025
415f63e
Add SCIM test step and generate instance snippets
vanngo-okta Feb 7, 2025
8760306
Add edit-links snippet for custom links
vanngo-okta Feb 9, 2025
1c38ae1
Edits to generate-instances, required-app-instances, test-instance sn…
vanngo-okta Feb 10, 2025
07a1684
Update edit-links snippet to raise acrolinx score
vanngo-okta Feb 10, 2025
e07719c
Increase score for saml2:edit-links
vanngo-okta Feb 10, 2025
4acd558
More edits for SCIM use case: required-app-instances and generate-ins…
vanngo-okta Feb 10, 2025
6a2adbd
MOre generate-instance snippet changes
vanngo-okta Feb 10, 2025
568e764
Add mapping instructions and image
vanngo-okta Feb 10, 2025
6b55238
Yay! Finish first draft of new topic
vanngo-okta Feb 10, 2025
426d5ab
remove extraneous snippets
vanngo-okta Feb 10, 2025
56a0079
Remove update published integration content in submit-oin-app
vanngo-okta Feb 11, 2025
d0b1102
Remove #update-your-integration and #update-integration-consideration…
vanngo-okta Feb 11, 2025
7224d4f
fix typo in conductor file
vanngo-okta Feb 11, 2025
92f6488
Remove backward-compatible-eg snippet in submit-oin-app
vanngo-okta Feb 11, 2025
d0d1aba
Removed lines with anchor
janugeethakumari-okta Feb 11, 2025
2422dba
addressed comments from Iunalii
janugeethakumari-okta Feb 13, 2025
1060fbc
Update packages/@okta/vuepress-site/docs/guides/submit-app/main/index.md
janugeethakumari-okta Feb 13, 2025
b98a9c4
Update packages/@okta/vuepress-site/docs/guides/update-oin-app/main/s…
janugeethakumari-okta Feb 13, 2025
60537cc
Update packages/@okta/vuepress-site/docs/guides/update-oin-app/main/s…
janugeethakumari-okta Feb 13, 2025
0843152
Update packages/@okta/vuepress-site/docs/guides/update-oin-app/main/s…
janugeethakumari-okta Feb 13, 2025
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 12 additions & 6 deletions packages/@okta/vuepress-site/conductor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4282,7 +4282,7 @@ redirects:
- from: /docs/guides/submit-app/openidconnect/submission3-process
to: /docs/guides/submit-app-overview/#understand-the-submission-review-process
- from: /docs/guides/submit-app/openidconnect/update-submission
to: /docs/guides/submit-oin-app/openidconnect/main/#update-your-integration
to: /docs/guides/update-oin-app/openidconnect/main/
- from: /docs/guides/submit-app/faqs
to: /docs/guides/submit-app-overview/
- from: /docs/guides/submit-app/openidconnect/overview/index.html
Expand All @@ -4296,7 +4296,7 @@ redirects:
- from: /docs/guides/submit-app/openidconnect/submission3-process/index.html
to: /docs/guides/submit-app-overview/#understand-the-submission-review-process
- from: /docs/guides/submit-app/openidconnect/update-submission/index.html
to: /docs/guides/submit-oin-app/openidconnect/main/#update-your-integration
to: /docs/guides/update-oin-app/openidconnect/main/
- from: /docs/guides/submit-app/faqs/index.html
to: /docs/guides/submit-app-overview/
- from: /docs/guides/submit-app/saml2/overview
Expand All @@ -4310,7 +4310,7 @@ redirects:
- from: /docs/guides/submit-app/saml2/submission3-process
to: /docs/guides/submit-app-overview/#understand-the-submission-review-process
- from: /docs/guides/submit-app/saml2/update-submission
to: /docs/guides/submit-oin-app/saml2/main/#update-your-integration
to: /docs/guides/update-oin-app/saml2/main/
- from: /docs/guides/submit-app/saml2/overview/index.html
to: /docs/guides/submit-oin-app/saml2/main/
- from: /docs/guides/submit-app/saml2/create-guide/index.html
Expand All @@ -4322,7 +4322,7 @@ redirects:
- from: /docs/guides/submit-app/saml2/submission3-process/index.html
to: /docs/guides/submit-app-overview/#understand-the-submission-review-process
- from: /docs/guides/submit-app/saml2/update-submission/index.html
to: /docs/guides/submit-oin-app/saml2/main/#update-your-integration
to: /docs/guides/update-oin-app/saml2/main/
- from: /docs/guides/submit-app/scim/overview
to: /docs/guides/submit-oin-app/scim/main/
- from: /docs/guides/submit-app/scim/create-guide
Expand All @@ -4334,7 +4334,7 @@ redirects:
- from: /docs/guides/submit-app/scim/submission3-process
to: /docs/guides/submit-app-overview/#understand-the-submission-review-process
- from: /docs/guides/submit-app/scim/update-submission
to: /docs/guides/submit-oin-app/scim/main/#update-your-integration
to: /docs/guides/update-oin-app/scim/main/
- from: /docs/guides/submit-app/scim/overview/index.html
to: /docs/guides/submit-oin-app/scim/main/
- from: /docs/guides/submit-app/scim/create-guide/index.html
Expand All @@ -4346,7 +4346,13 @@ redirects:
- from: /docs/guides/submit-app/scim/submission3-process/index.html
to: /docs/guides/submit-app-overview/#understand-the-submission-review-process
- from: /docs/guides/submit-app/scim/update-submission/index.html
to: /docs/guides/submit-oin-app/scim/main/#update-your-integration
to: /docs/guides/update-oin-app/scim/main/
- from: /docs/guides/submit-oin-app/openidconnect/main/#update-your-integration
to: /docs/guides/update-oin-app/openidconnect/main/
- from: /docs/guides/submit-oin-app/saml2/main/#update-your-integration
to: /docs/guides/update-oin-app/saml2/main/
- from: /docs/guides/submit-oin-app/scim/main/#update-your-integration
to: /docs/guides/update-oin-app/scim/main/
- from: /docs/guides/submit-app/openidconnect/main
to: /docs/guides/submit-oin-app/openidconnect/main/
- from: /docs/guides/submit-app/openidconnect/main/index.html
Expand Down
1 change: 1 addition & 0 deletions packages/@okta/vuepress-site/docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ guides:
- submit-app
- submit-app-prereq
- submit-oin-app
- update-oin-app
- add-private-app
- deployment-checklist
- deploy-your-app
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ layout: Guides

Use this guide to understand the process of submitting Workflows connector and API service integrations to the Okta Integration Network (OIN) using the OIN Manager. This guide also shows you how to update a previously published integration or delete a draft submission.

> **Note:** For SSO or Lifecycle Management (LCM) SCIM integrations, use the [OIN Wizard](/docs/guides/submit-oin-app/scim/main/) for a seamless ISV submission experience. Previously submitted SSO and LCM SCIM integrations from the OIN Manager have been migrated to the OIN Wizard. You can edit these published integrations directly in the OIN Wizard and resubmit them to the OIN team. See [Update your integration](/docs/guides/submit-oin-app/scim/main/#update-your-integration).
> **Note:** For SSO or Lifecycle Management (LCM) SCIM integrations, use the [OIN Wizard](/docs/guides/submit-oin-app/scim/main/) for a seamless ISV submission experience. Previously submitted SSO and LCM SCIM integrations from the OIN Manager have been migrated to the OIN Wizard. You can edit these published integrations directly in the OIN Wizard and resubmit them to the OIN team. See [Update a published integration with the OIN Wizard](/docs/guides/update-oin-app/).

---

Expand Down Expand Up @@ -127,7 +127,7 @@ Include all required information before you click **Submit for Review** to move

If you need to edit your published integration, use the [OIN Manager](https://oinmanager.okta.com/) to create an updated version of the integration.

> **Note:** As of release 2024.11.0, use the OIN Wizard to [edit your published SCIM integration](/docs/guides/submit-oin-app/scim/main/#update-your-integration). Previous SCIM integrations submitted through the OIN Manager are now available through the **Your OIN Integrations** dashboard in the Admin Console.
> **Note:** Use the OIN Wizard to [edit your published SCIM integration](/docs/guides/update-oin-app/scim/main/). Previous SCIM integrations submitted through the OIN Manager are now available through the **Your OIN Integrations** dashboard in the Admin Console.
> If you submitted a SCIM integration through the OIN Manager and the OIN review process hasn't started, resubmitted it in the OIN Wizard.

1. Sign in to the OIN Manager using the credentials for the original submission Okta Developer Edition org.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ To assign test users to your integration:
The **Required app instances** box shows you the instances detected in your org that are available to test your integration. It also shows you the test instances required for the OIN Submission Tester based on your selected protocols:

* The **CURRENT VERSION** status indicates the instances that you need to test your current integration submission.
* The **PUBLISHED VERSION** status indicates the instances that you need to test backwards compatibility if you edit a previously published integration. See [Update your integration](#update-your-integration).
* The **PUBLISHED VERSION** status indicates the instances that you need to test backwards compatibility if you edit a previously published integration. See [Update a published integration with the OIN Wizard](/docs/guides/update-oin-app/).

### Application instances for testing

Expand Down Expand Up @@ -546,81 +546,7 @@ Execute the test cases in the [Okta SCIM Test Plan](/standards/SCIM/SCIMFiles/ok

Depending on your test scenario, you can import users from the **Import** tab (see [Import users](https://help.okta.com/okta_help.htm?id=ext_Importing_People)) or create users in Okta before assigning them to your test instance. See [About adding provisioned users](https://help.okta.com/okta_help.htm?type=oie&id=lcm-about-user-management) and [Assign test users to your integration instance](#assign-test-users-to-your-integration-instance).

After you've successfully completed the manual SCIM integration tests, see [Submit your integration](#submit-your-integration).

## Update your integration

You can modify your published SSO and/or SCIM integrations in the OIN Wizard.

When you edit a published OIN integration, test the flows for the updated version and the published version for backwards compatibility. Testing the published version for backwards compatibility ensures that your integration still works for users who have already installed it. See [Update integration considerations](#update-integration-considerations) before you edit your published integration. After you successfully test the updated and published versions of your integration, resubmit it to the OIN team.

> **Note:** When you edit your published OIN integration, your previous PUBLISHED status and date are overwritten with the DRAFT status and current date.

To update a previously published OIN integration:

1. Sign in to your Okta Developer Edition org as a user with either app admin or super admin roles.
> **Note:** Edit your integration from an Okta account that has your company domain in the email address. You can't use an account with a personal email address. The OIN team doesn't review submission edits from a personal email account.
1. In the Admin Console, go to **Applications** > **Your OIN Integrations**.

> **Note:** If you don't need to edit your submission and want to jump to testing, see [Navigate directly to test your integration](#navigate-directly-to-test-your-integration).

1. Click your published integration to update from the dashboard. Your published OIN submission appears in read-only mode.
1. From the **This integration is read-only** information box, click **Edit integration**.
> **Note:** If you open a submission in **DRAFT** status, it's not in read-only mode and the **Edit integration** option isn't available.

Continue to edit your draft submission as a new submission. See [Start a submission](#start-a-submission).
1. If the OIN Wizard doesn't detect an instance to test your published integration in the org, then an **Application instance not detected** dialog appears. Click **Generate instance** to create an app instance based on your published OIN integration. See [Add existing app integrations](https://help.okta.com/okta_help.htm?type=oie&id=csh-apps-add-app) to create an instance for backwards-compatibility testing.
> **Note:** The **Generate instance** option is disabled if you have five active instances in your org. [Deactivate instances](#deactivate-an-app-instance-in-your-org) that you're not using.

If the OIN Wizard detects an instance based on your published integration, the dialog doesn't appear. This is usually the case if you tested and submitted your published integration from the same org.

1. Continue to update your integration in the **Select protocol**, **Configure your integration**, and **Test integration** pages. See [Update integration considerations](#update-integration-considerations) for backwards compatibility with integration variables.

The **Required app instances** box contains the following items:
* The instances that you need to test the **PUBLISHED VERSION** of your OIN integration.
* The instances that you need to test the **CURRENT VERSION** of your integration submission.

See [Required app instances](#required-app-instances).
> **Note:** If the OIN Submission Tester session expired, click **Refresh tester session** for a new test session.

Backwards-compatible test instances that were generated from your published integration appear in the **Application instances for testing** list.

1. Click **Generate Instance** to create an instance required for the **CURRENT VERSION** from the **Required app instances** status box.

See [Generate an instance for testing](#generate-an-instance-for) to create instances for your current submission.
> **Note:** There's a maximum of five active app instances allowed in a Developer Edition org. Deactivate any instances that you don't need for testing.

1. Test your integration protocol:

* For SSO testing, click **Add to Tester** for each required test instance. See [Add to Tester](#add-to-tester).<br> The required tests appear for each test instance. Run your tests from the OIN Submission Tester. See [OIN Submission Tester](#oin-submission-tester). If you encounter errors, see [Failed tests](#failed-tests) for help with resolving the issues.

* For SCIM testing, see [Test your SCIM integration](#test-your-scim-integration) for all the test requirements.

1. [Submit your integration](#submit-your-integration) if all your tests passed.

### Update integration considerations

* For published integrations that were migrated from the OIN Manager, if you need to update configured properties that aren't available the OIN Wizard, contact <[email protected]>.

* You can't update a published SCIM integration with Basic authentication. This breaks the integration for existing customers. For any updates, you must submit a new SCIM integration that implements header authentication or OAuth 2.0 authentication. You can use either token or bearer token format for header authentication.

* If you edit a published SCIM integration that was migrated from the OIN Manager, the **Import users** (and **Import groups** if groups are managed) capability is automatically enabled in the OIN Wizard. You must support and test this capability if your previous SCIM integration didn't support it. If you need help with implementing this feature, contact <[email protected]>.

* When you update an integration that's already published, be mindful to preserve backwards compatibility for your integration. Older instances of your integration could be in use by Okta customers.

* If you modify the **Name** (`name`) property of your [integration variables](#integration-variables), Okta removes the original variable and creates a variable with your updated name. This action negatively impacts your existing customers if you use the original variable in your integration dynamic properties.

* Migrated published integrations from the OIN Manager don't have some OIN Wizard restrictions. For instance:

* Published integrations can have more than three integration variables
* Published integrations can have variable names with uppercase letters
* Published integrations can use `http` (instead of enforced `https`) in URLs and Expression Language-supported properties

* If your update introduces new variables and you're using dynamic URLs, ensure that your tests cover various scenarios with different possible values for those variables. See [Dynamic properties with Okta Expression Language](#dynamic-properties-with-okta-expression-language). The newly introduced variables aren't populated for older instances of your integration.

For example:

<StackSnippet snippet="backward-compatible-eg" />
After you've successfully completed the manual SCIM integration tests, you can submit your integration.

## Submit your integration

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Update a published integration with the OIN Wizard
meta:
- name: description
content: Learn how to update your published integration in the Okta Integration Network (OIN). The update and submit tasks are performed in the Okta Admin Console through the OIN Wizard.
layout: Guides
sections:
- main
---
Loading