diff --git a/packages/@okta/vuepress-site/.vuepress/public/img/oin/scim_unmap-attribute.png b/packages/@okta/vuepress-site/.vuepress/public/img/oin/scim_unmap-attribute.png new file mode 100644 index 00000000000..06ed47cd33b Binary files /dev/null and b/packages/@okta/vuepress-site/.vuepress/public/img/oin/scim_unmap-attribute.png differ diff --git a/packages/@okta/vuepress-site/conductor.yml b/packages/@okta/vuepress-site/conductor.yml index aa471de87f3..c30a6fa8fa9 100644 --- a/packages/@okta/vuepress-site/conductor.yml +++ b/packages/@okta/vuepress-site/conductor.yml @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/packages/@okta/vuepress-site/docs/guides/index.md b/packages/@okta/vuepress-site/docs/guides/index.md index cc0d089974b..f8aced909e5 100644 --- a/packages/@okta/vuepress-site/docs/guides/index.md +++ b/packages/@okta/vuepress-site/docs/guides/index.md @@ -72,6 +72,7 @@ guides: - submit-app - submit-app-prereq - submit-oin-app + - update-oin-app - add-private-app - deployment-checklist - deploy-your-app diff --git a/packages/@okta/vuepress-site/docs/guides/submit-app/main/index.md b/packages/@okta/vuepress-site/docs/guides/submit-app/main/index.md index 3a9f38493de..943829db0b2 100644 --- a/packages/@okta/vuepress-site/docs/guides/submit-app/main/index.md +++ b/packages/@okta/vuepress-site/docs/guides/submit-app/main/index.md @@ -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/). --- @@ -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. diff --git a/packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/index.md b/packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/index.md index b2a360cadef..2212cca4f12 100644 --- a/packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/index.md +++ b/packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/index.md @@ -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 @@ -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).
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 . - -* 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 . - -* 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: - - +After you've successfully completed the manual SCIM integration tests, you can submit your integration. ## Submit your integration diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/index.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/index.md new file mode 100644 index 00000000000..4efa88cbfbe --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/index.md @@ -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 +--- diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/index.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/index.md new file mode 100644 index 00000000000..53c74bbe64b --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/index.md @@ -0,0 +1,146 @@ +--- +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). You can make updates and resubmit your integration in the OIN Wizard. The OIN team reviews your submission and updates the OIN catalog after your integration has been verified. +layout: Guides +--- + +Learn how to update an OIDC, SAML 2.0, or SCIM 2.0 published integration in the Okta Integration Network (OIN) using the OIN Wizard. + +--- + +#### What you need + +* A published OIDC, SAML 2.0, or SCIM integration in the OIN +* The [Okta Developer Edition org](https://developer.okta.com/signup/) from where you originally submitted your published integration. The OIN Wizard is only available in Okta Developer Edition orgs. +* An admin user in the Okta Developer Edition org with either the super admin or the app and org admin roles + +--- + +## Overview + +If you have a published Single Sign-On (SSO) or lifecycle management integration in the [OIN catalog](https://www.okta.com/integrations/), you can update and resubmit it with the OIN Wizard. + +The OIN Wizard currently supports updates for integrations that use the following protocols: + +* [OpenID Connect (OIDC)](https://openid.net/connect/) + +* [Security Assertion Markup Language (SAML) 2.0](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html) + +* [System for Cross-domain Identity Management (SCIM) 2.0](https://scim.cloud) + +> **Note:** You can also update OIDC, SAML 2.0, and SCIM 2.0 integrations with the [OIN Wizard](/docs/guides/update-oin-app/) that were originally submitted through the [OIN Manager](/docs/guides/submit-app/). + +When you edit a published OIN integration, you need to test the flows for the updated version and the published version for backwards compatibility. The integration version that was previously installed in your customer's org isn't modified with the updated version from the OIN catalog. Testing the published version for backwards compatibility ensures that your integration still works for customers 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 your integration to the OIN team. Your integration goes through a [submission review process](/docs/guides/submit-app-overview/#understand-the-submission-review-process) before the updated version is published in the OIN catalog. + +## 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 . + +> **Note:** Some considerations on this page are specifically for the **** protocol.
+> If you want to change the protocol details on this page, select the protocol from the **Instructions for** dropdown list on the right. + + + +* 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](/docs/guides/submit-oin-app/openidconnect/main/#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. The newly introduced variables aren't populated for older instances of your integration. + + For example: + + + +## Update your integration + +> **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 have a draft submission and want to go straight to testing, see [Navigate directly to test your integration](/docs/guides/submit-oin-app/openidconnect/main/#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:** You can skip this step if your submission is in draft status. The **Edit integration** option isn't available for submissions in draft status because it's not in read-only mode. + + + +1. Click **Configure your integration** to proceed to update your integration as required in the following sections of the OIN Wizard: + + + +1. Click **Test your integration** to save your updates and move to the testing section of the OIN Wizard. + +## Test integration updates + +The OIN Wizard journey includes the **Test integration** experience page to help you configure and test your updated integration within the same org before submission. These are the tasks that you need to complete: + + +
+ +See [Submit your updated integration](#submit-your-updates) after all required tests are successful. + +> **Note:** Test steps on this page are specifically for the **** protocol.
+> If you want to change the protocol details on this page, select the protocol from the **Instructions for** dropdown list on the right. + +### Generate instances for testing + +Generate instances for testing your updates directly from the OIN Wizard. See [Required app instances](#required-app-instances) in the OIN Wizard for the instances that you need to generate. + +#### Required app instances + + + +#### Generate an instance + + + +### Test your integration + + + +## Submit your updates + +After you successfully test your updated integration, you're ready to submit. + + +
+ +**Submit integration** is enabled after all these requirements are met. + +1. Select **I certify that I have successfully completed required tests**. +1. Click **Submit integration** to submit your integration. +1. Click **Close wizard**. + The **Your OIN Integration** dashboard appears. + +After you submit your integration, your integration is queued for OIN initial review. Okta sends you an email with the expected initial review completion date. + +Check the status of your submission on the **Your OIN Integrations** dashboard. See [Understand the submission review process](/docs/guides/submit-app-overview/#understand-the-submission-review-process). + +## Submission support + +If you need help during your submission, Okta provides the following support: + +* If you need help with the OIN Wizard, review this document or see [Publish an OIN integration](/docs/guides/submit-app-overview/). + +* Submit your OIN Wizard question to if you can't find an answer in the documentation. + +* If you have issues during your integration testing phase, you can post a question on the [Okta Developer Forum](https://devforum.okta.com/) or submit your question to . + +* If you have an integration status issue, contact . diff --git a/packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/openidconnect/backward-compatible-eg.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/backward-compatible-eg.md similarity index 78% rename from packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/openidconnect/backward-compatible-eg.md rename to packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/backward-compatible-eg.md index 969092af031..63af52382e2 100644 --- a/packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/openidconnect/backward-compatible-eg.md +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/backward-compatible-eg.md @@ -6,4 +6,4 @@ https://{String.len(app.companyId) == 0 ? 'login.myapp.io' : 'login.myapp.io?connection=' + app.companyId} ``` - This expression handles both scenarios where `companyId` is populated or empty. \ No newline at end of file + This expression handles both scenarios where `companyId` is populated or empty. See [Dynamic properties with Okta Expression Language](/docs/guides/submit-oin-app/openidconnect/main/#dynamic-properties-with-okta-expression-language). diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/considerations.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/considerations.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/detect-old-instance.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/detect-old-instance.md new file mode 100644 index 00000000000..ade684c3d83 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/detect-old-instance.md @@ -0,0 +1,7 @@ +* For SSO integrations, if the OIN Wizard doesn't detect an instance to test your published integration, an **Application instance not detected** dialog appears. + + 1. 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 OIN-published instance for backwards-compatibility testing. + + 1. If the **Application instance not detected** dialog appears and the **Generate instance** option is disabled, then you exceeded the maximum active instances in your org. [Deactivate instances](/docs/guides/submit-oin-app/openidconnect/main/#deactivate-an-app-instance-in-your-org) that you're not using before you generate new instances. + +* If the OIN Wizard detects an instance based on your published integration, the **Application instance not detected** dialog doesn't appear. This is usually the case if you tested and submitted your published integration from the same org. You can use that existing published-version instance for backwards-compatiblity testing. diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/edit-links.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/edit-links.md new file mode 100644 index 00000000000..b84155e55d1 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/edit-links.md @@ -0,0 +1,5 @@ +* [OIN catalog properties](/docs/guides/submit-oin-app/openidconnect/main/#oin-catalog-properties) +* [Integration variables](/docs/guides/submit-oin-app/openidconnect/main/#integration-variables) + > **Note:** See [Update integration considerations](#update-integration-considerations) for backwards compatibility with integration variables. +* [OIDC properties](/docs/guides/submit-oin-app/openidconnect/main/#properties) +* [Enter test information](/docs/guides/submit-oin-app/openidconnect/main/#enter-test-information) diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/generate-instance.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/generate-instance.md new file mode 100644 index 00000000000..7272addb939 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/generate-instance.md @@ -0,0 +1,5 @@ +1. Create an instance for your updated OIDC integration. See [Generate an instance for OIDC](/docs/guides/submit-oin-app/openidconnect/main/#generate-an-instance-for). + +1. Assign test users for your generated instance. See [Assign test users to your integration instance](/docs/guides/submit-oin-app/openidconnect/main/#assign-test-users-to-your-integration-instance). + +Next, go to [Test your integration](#test-your-integration). diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/protocol-name.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/protocol-name.md new file mode 100644 index 00000000000..182eb94aac2 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/protocol-name.md @@ -0,0 +1 @@ +OpenID Connect \ No newline at end of file diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/required-app-instances.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/required-app-instances.md new file mode 100644 index 00000000000..0b95f7bca1a --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/required-app-instances.md @@ -0,0 +1,10 @@ +The **Required app instances** section shows you the instances detected in your org that are required for the OIN Submission Tester: + +* 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. + +[Generate an instance](#generate-an-instance) to test the specific protocol if **No instance detected** appears next to the protocol. + +> **Notes:** +> * Generate separate instances for testing if you support two SSO protocols (one for OIDC and one for SAML). The OIN Submission Tester can only test one protocol per instance. +> * You should already have an instance of your published integration for backwards-compatibility testing. If you don't have a published-version instance, exit the OIN Wizard and create the OIN-published instance. See [Add existing app integrations](https://help.okta.com/okta_help.htm?type=oie&id=csh-apps-add-app) to create an OIN-published instance for backwards-compatibility testing. diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/submit-checks.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/submit-checks.md new file mode 100644 index 00000000000..caf7f9b4bc2 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/submit-checks.md @@ -0,0 +1,5 @@ +The OIN Wizard checks the following for SSO submissions: + +* All required instances are detected. +* All required instances are active. +* All required tests for the updated and backwards-compatible instances passed within the last 48 hours. diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/test-instance.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/test-instance.md new file mode 100644 index 00000000000..454d4f53b01 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/test-instance.md @@ -0,0 +1,5 @@ +For an SSO integration, use the OIN Submission Tester to test the required flows on your generated test instance. + +1. Go to the [Application instance for testing](/docs/guides/submit-oin-app/openidconnect/main/#application-instances-for-testing) section on the **Test integration** page. +1. Add your test instance to the OIN Submission Tester. See [Add to Tester](/docs/guides/submit-oin-app/openidconnect/main/#add-to-tester). +1. Run the required tests in the OIN Submission Tester. See [OIN Submission Tester](/docs/guides/submit-oin-app/openidconnect/main/#oin-submission-tester). diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/test-steps.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/test-steps.md new file mode 100644 index 00000000000..0169531a581 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/test-steps.md @@ -0,0 +1,3 @@ +1. Generate app instances from your updated integration and assign test users. See [Generate instances for testing](#generate-instances-for-testing). + +1. Test the required flows for each of your SSO instances. See [Test your integration](#test-your-integration). diff --git a/packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/saml2/backward-compatible-eg.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/backward-compatible-eg.md similarity index 59% rename from packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/saml2/backward-compatible-eg.md rename to packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/backward-compatible-eg.md index 5c246d9d52a..d9281455f8e 100644 --- a/packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/saml2/backward-compatible-eg.md +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/backward-compatible-eg.md @@ -1,4 +1,4 @@ - Your integration update introduced a new variable (`companyId`), and you use it in your updated ACS URL. The ACS URL changed from `https://login.myapp.io` to `https://login.myapp.io?connection={org.companyId}`. In this case, ensure that the dynamic ACS URL is also valid for existing instances where the `companyId` value isn't set. + Your integration update introduced a new variable (`companyId`), and you use it in your updated ACS URL. The ACS URL changed from `https://login.myapp.io` to `https://login.myapp.io?connection=${org.companyId}`. In this case, ensure that the dynamic ACS URL is also valid for existing instances where the `companyId` value isn't set. To handle empty `companyId` values, you can define the ACS URL as: @@ -6,4 +6,4 @@ https://${empty org.companyId ? 'login.myapp.io' : 'login.myapp.io?connection=' += org.companyId} ``` - This expression handles both scenarios where `companyId` is populated or empty. \ No newline at end of file + This expression handles both scenarios where `companyId` is populated or empty. See [Dynamic properties with Okta Expression Language](/docs/guides/submit-oin-app/saml2/main/#dynamic-properties-with-okta-expression-language). diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/considerations.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/considerations.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/detect-old-instance.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/detect-old-instance.md new file mode 100644 index 00000000000..ade684c3d83 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/detect-old-instance.md @@ -0,0 +1,7 @@ +* For SSO integrations, if the OIN Wizard doesn't detect an instance to test your published integration, an **Application instance not detected** dialog appears. + + 1. 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 OIN-published instance for backwards-compatibility testing. + + 1. If the **Application instance not detected** dialog appears and the **Generate instance** option is disabled, then you exceeded the maximum active instances in your org. [Deactivate instances](/docs/guides/submit-oin-app/openidconnect/main/#deactivate-an-app-instance-in-your-org) that you're not using before you generate new instances. + +* If the OIN Wizard detects an instance based on your published integration, the **Application instance not detected** dialog doesn't appear. This is usually the case if you tested and submitted your published integration from the same org. You can use that existing published-version instance for backwards-compatiblity testing. diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/edit-links.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/edit-links.md new file mode 100644 index 00000000000..ac1df8d6b7a --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/edit-links.md @@ -0,0 +1,5 @@ +* [OIN catalog properties](/docs/guides/submit-oin-app/saml2/main/#oin-catalog-properties) +* [Integration variables](/docs/guides/submit-oin-app/saml2/main/#integration-variables) + > **Note:** See [Update integration considerations](#update-integration-considerations) for backwards compatibility with integration variables. +* [SAML 2.0 properties](/docs/guides/submit-oin-app/saml2/main/#properties) +* [Test information](/docs/guides/submit-oin-app/saml2/main/#enter-test-information) diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/generate-instance.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/generate-instance.md new file mode 100644 index 00000000000..f6d09a7a8f3 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/generate-instance.md @@ -0,0 +1,5 @@ +1. Create an instance for your updated SAML integration. See [Generate an instance for SAML](/docs/guides/submit-oin-app/saml2/main/#generate-an-instance-for). + +1. Assign test users for your generated instance. See [Assign test users to your integration instance](/docs/guides/submit-oin-app/saml2/main/#assign-test-users-to-your-integration-instance). + +Next, go to [Test your integration](#test-your-integration). diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/protocol-name.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/protocol-name.md new file mode 100644 index 00000000000..7945954acb0 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/protocol-name.md @@ -0,0 +1 @@ +SAML 2.0 \ No newline at end of file diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/required-app-instances.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/required-app-instances.md new file mode 100644 index 00000000000..fef3b45d89b --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/required-app-instances.md @@ -0,0 +1,10 @@ +The **Required app instances** section shows you the instances detected in your org that are required for the OIN Submission Tester: + +* 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. + +[Generate an instance](#generate-an-instance) to test the specific protocol if **No instance detected** appears next to the protocol. + +> **Notes:** +> * Generate separate instances for testing if you support two SSO protocols (one for OIDC and one for SAML). The OIN Submission Tester can only test one protocol per instance. +> * You should already have an instance of your published integration for backwards-compatibility testing. If you don't have a published-version instance, exit the OIN Wizard and create the OIN-published instance. See [Add existing app integrations](https://help.okta.com/okta_help.htm?type=oie&id=csh-apps-add-app) to create an OIN-published instance for backwards-compatibility testing. \ No newline at end of file diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/submit-checks.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/submit-checks.md new file mode 100644 index 00000000000..caf7f9b4bc2 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/submit-checks.md @@ -0,0 +1,5 @@ +The OIN Wizard checks the following for SSO submissions: + +* All required instances are detected. +* All required instances are active. +* All required tests for the updated and backwards-compatible instances passed within the last 48 hours. diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/test-instance.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/test-instance.md new file mode 100644 index 00000000000..2d77b3f5f75 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/test-instance.md @@ -0,0 +1,5 @@ +For an SSO integration, use the OIN Submission Tester to test the required flows on your generated test instance. + +1. Go to the [Application instance for testing](/docs/guides/submit-oin-app/saml2/main/#application-instances-for-testing) section on the **Test integration** page. +1. Add your test instance to the OIN Submission Tester. See [Add to Tester](/docs/guides/submit-oin-app/saml2/main/#add-to-tester). +1. Run the required tests in the OIN Submission Tester. Fix any test failures, then regenerate the test instance (if necessary) and retest. See [OIN Submission Tester](/docs/guides/submit-oin-app/saml2/main/#oin-submission-tester). diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/test-steps.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/test-steps.md new file mode 100644 index 00000000000..0169531a581 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/saml2/test-steps.md @@ -0,0 +1,3 @@ +1. Generate app instances from your updated integration and assign test users. See [Generate instances for testing](#generate-instances-for-testing). + +1. Test the required flows for each of your SSO instances. See [Test your integration](#test-your-integration). diff --git a/packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/scim/backward-compatible-eg.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/backward-compatible-eg.md similarity index 56% rename from packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/scim/backward-compatible-eg.md rename to packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/backward-compatible-eg.md index 2f18e423586..3ee8477b538 100644 --- a/packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/scim/backward-compatible-eg.md +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/backward-compatible-eg.md @@ -1,4 +1,4 @@ - Your integration update introduced a new variable (`companyId`), and you use it in your updated SCIM server base URL. The base URL changed from `https://fruits.example.com/scim2/myapp/` to `https://fruits.example.com/scim2/myapp?connection={app.companyId}`. In this case, ensure that the dynamic base URL is also valid for existing instances where the `companyId` value isn't set. + Your integration update introduced a new variable (`companyId`), and you use it in your updated SCIM server base URL. The base URL changed from `https://fruits.example.com/scim2/myapp/` to `'https://fruits.example.com/scim2/myapp?connection=' + app.companyId`. In this case, ensure that the dynamic base URL is also valid for existing instances where the `companyId` value isn't set. To handle empty `companyId` values, you can define the base URL as: @@ -6,4 +6,4 @@ 'https://fruits.example.com/scim2/myapp' + (String.len(app.companyId) == 0 ? '/' : '?connection=' + app.companyId) ``` - This expression handles scenarios where `companyId` is populated or empty. + This expression handles scenarios where `companyId` is populated or empty. See [Dynamic properties with Okta Expression Language](/docs/guides/submit-oin-app/scim/main/#dynamic-properties-with-okta-expression-language). diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/considerations.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/considerations.md new file mode 100644 index 00000000000..01c7cf2dbca --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/considerations.md @@ -0,0 +1,3 @@ +* 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 . diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/detect-old-instance.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/detect-old-instance.md new file mode 100644 index 00000000000..c09e48d8188 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/detect-old-instance.md @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/edit-links.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/edit-links.md new file mode 100644 index 00000000000..ccc72ac6940 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/edit-links.md @@ -0,0 +1,5 @@ +* [OIN catalog properties](/docs/guides/submit-oin-app/scim/main/#oin-catalog-properties) +* [Integration variables](/docs/guides/submit-oin-app/scim/main/#integration-variables) + > **Note:** See [Update integration considerations](#update-integration-considerations) for backwards compatibility with integration variables. +* [SCIM properties](/docs/guides/submit-oin-app/scim/main/#properties) +* [Enter test information](/docs/guides/submit-oin-app/scim/main/#enter-test-information) diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/generate-instance.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/generate-instance.md new file mode 100644 index 00000000000..eae0fa95e9a --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/generate-instance.md @@ -0,0 +1,97 @@ +Generate a SCIM instance based on your submission configuration: + +1. From the **Test integration** page, click **Generate instance**. A page appears to add your instance details. + + > **Note:** There's a limit of five app instances in an Okta Developer Edition org. The **Generate instance** option is deactivated when you reach this limit. Deactivate unused instances to make room for new instances in your org. See [Deactivate app instances in your org](/docs/guides/submit-oin-app/scim/main/#deactivate-an-app-instance-in-your-org). + +1. In the **General settings** tab, enter an **Application label** and any other required integration properties. +1. Click **Done**. Your generated test instance appears with more tabs for configuration. +1. Click **Provisioning** > **Configure API Integration**. +1. Select **Enable API integration**. + * For custom or bearer authentication, specify the **API token** for your instance. + * For OAuth 2.0 authentication, click **Authenticate with {yourApp}** and provide credentials for your test instance. +1. Click **Test API Credentials** to test authentication to your SCIM service. If there's an error, verify that the credentials are correct. +1. Click **Save**. +1. Select **Settings** > **To Okta** from the updated **Provisioning** tab. +1. In the **General** section, click **Edit** to schedule imports and configure the username format for imported users. + + You can also define a percentage of acceptable assignments before the [import safeguards](https://help.okta.com/okta_help.htm?id=csh-eu-import-safeguard) feature is automatically triggered. + +1. Click **Save**. Next, [configure attribute mappings](#configure-attribute-mappings). + +> **Note:** Your SCIM app must support redirect URIs that include the app name (`{appName}`). This app name string is generated after you create your app instance. See SCIM service [authentication](/docs/guides/scim-provisioning-integration-prepare/main/#authentication) for a list of redirect URIs required. Your app name appears in the **General settings** tab or in the Admin Console URL when you're viewing the instance page. + +#### Configure attribute mappings + +SCIM attribute mappings are configured at the instance-level. Ensure that these mappings reflect the current attributes supported by your app. The OIN team uses the updated attribute mappings in your test instance for integration provisioning settings in the OIN catalog. + +After you've enabled the provisioning API connection in your test instance, configure attribute mappings to and from Okta in the **Provisioning** tab: + +* **To App**: User attribute mappings from Okta to your app +* **To Okta**: User attribute mappings from your app to Okta + +1. Select **To App** on the left **Settings** panel of the **Provisioning** tab. + The **Provisioning to App** settings appear. The provisioning operations are already set by default from the [SCIM properties](#properties) section when you configured your integration. + +1. Scroll to the **{yourApp} Attribute Mappings** section. +1. Click **Go to Profile Editor**. + + * Add attributes: + + 1. In the Profile Editor, click **Add Attribute**. + + 1. Enter the information for the new attribute that you’re adding and then click **Save**. + + > **Note:** The **Scope** property determines whether the attribute that you're adding can be assigned at a group level or per user. If you want your admins to assign a value for this attribute at a group level, don't select the **User personal** checkbox. + + 1. After adding attributes, go back to the **{yourApp} Attribute Mappings** section and click **Edit** to map your new attributes. A dialog appears with two dropdown fields. + + 1. Select **Map from Okta Profile** in the first dropdown list. + 1. In the second dropdown list, select the Okta profile attribute that you want to map over to the SCIM attribute. + 1. Click **Save**. + + Repeat these steps for all SCIM attributes that you want to map (from Okta to your app). +
+ + ![Displays the map attribute dialog.](/img/oin/scim_check-attributes-14.png) + +
+ + 7. After you update the mappings from Okta to your app, click **To Okta** in the **Settings** section. + 8. Scroll to the **{yourApp} Attribute Mappings** section. Find the attribute that you want to update and click **Edit**. A dialog appears with two dropdown fields next to **Attribute value**. + 9. Select **Map from {yourApp} App Profile** from the first dropdown list. + 10. In the second dropdown list, select the SCIM attribute that you want to map to the Okta attribute. + 11. Click **Save**. + + Repeat these steps for all SCIM attributes that you want to map from your app to Okta (in the **Settings** > **To Okta** panel). + + * Delete attributes: + + 1. In the Profile Editor, click **Mappings**. + 1. Click **{yourApp} to Okta User** at the top of the page. + 1. Scroll to the attribute that you want to delete, click the mapping icon (yellow arrow) and select **Do not map**. + +
+ + ![Displays the map attribute dialog.](/img/oin/scim_unmap-attribute.png) + +
+ + 1. Click **Save Mappings**. + + Perform **Do not map** and **Save Mappings** actions for all attributes that you want to remove from your app to Okta mappings. + 1. Click **Apply updates now** to save all the attributes you unmapped. + + 1. In the Profile Editor, click **Mappings**. + 1. Click **Okta User to {yourApp}** at the top of the page. + 1. Scroll to the attribute that you want to delete, click the mapping icon (yellow arrow) and select **Do not map**. + 1. Click **Save Mappings**. + + Perform **Do not map** and **Save Mappings** actions for all attributes that you want to remove from Okta to your app mappings. + 1. Click **Apply updates now** to save all the attributes you unmapped. + + 1. In the Profile Editor, delete all the corresponding attributes from the mapping by clicking **X** next to the attribute and then clicking **Delete Attribute** to confirm. + + Repeat this step for all the attributes that you want to delete. + +After you complete your attribute mappings, you're ready to [test your integration](#test-your-integration). diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/protocol-name.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/protocol-name.md new file mode 100644 index 00000000000..31ab7a9f854 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/protocol-name.md @@ -0,0 +1 @@ +SCIM \ No newline at end of file diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/required-app-instances.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/required-app-instances.md new file mode 100644 index 00000000000..bace0974017 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/required-app-instances.md @@ -0,0 +1,21 @@ +The **Required app instances** section shows you the instances detected in your org that are required to test your integration. + +* The **CURRENT VERSION** status indicates the instances that you need to test your current integration submission. [Generate an instance](#generate-an-instance) to test SCIM if **No instance detected** appears next to the **SCIM** label. +* The **PUBLISHED VERSION** status indicates the instances that you need to test backwards compatibility for SSO. If your integration only supports the SCIM protocol, then the OIN Wizard doesn't require a published-version instance. + +Depending on the nature of your updates, you may need to generate instances for backwards-compatibility testing. Okta recommends that you execute the Runscope tests on your SCIM published-version instance for backwards compatibility, but it's not a requirement for submission. + + * If you're only updating app profiles or mapping, then you don't need to create an extra app instance for SCIM backwards-compatibility testing. You can test the app profile updates in the updated instance version of your submission. See [Configure attribute mappings](#configure-attribute-mappings) when you generate a SCIM instance for testing. However, if you're updating the properties such as description, logo, or guide link, then Okta recommends that you create an extra app instance for SCIM backwards-compatibility testing. + + * If you're updating all other properties from the **Configure your integration** and **Test integration** pages, then Okta recommends SCIM backwards-compatibility testing: + + * If you tested and submitted your published integration from the same Okta Developer Edition org, you might already have an existing backwards-compatible instance. Use this older app instance version to test backwards compatibility. See [Test your integration](#test-your-integration). + + * If you don't have an instance based on the published integration, exit the OIN Wizard and create an instance of the SCIM OIN-published instance. See [Add existing app integrations](https://help.okta.com/okta_help.htm?type=oie&id=csh-apps-add-app) to create an OIN-published instance for SCIM backwards-compatibility testing. + +> **Notes:** If your integration also supports SSO: +> * You can avoid creating another app instance for SSO testing if these conditions apply: +> * Your integration supports SCIM and one SSO protocol. +> * Your integration doesn't support SSO JIT. +> * The **Create User** SCIM operation is enabled. +> * You should already have an instance of your published integration for SSO backwards-compatibility testing. The OIN Wizard ensures that an SSO published instance is available in your org before you update your integration. If you don't have a published-version instance for SSO testing, exit the OIN Wizard and create the SSO OIN-published instance. See [Add existing app integrations](https://help.okta.com/okta_help.htm?type=oie&id=csh-apps-add-app) to create an OIN-published instance for backwards-compatibility testing. diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/submit-checks.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/submit-checks.md new file mode 100644 index 00000000000..b860c2599a8 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/submit-checks.md @@ -0,0 +1,6 @@ +The OIN Wizard checks the following for SCIM submissions: + +* All required instances are detected. +* All required instances are active. +* The **Link to Runscope spec test results** field is specified. +* The **Link to Runscope CRUD test results** field is specified. diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/test-instance.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/test-instance.md new file mode 100644 index 00000000000..0191ab58b80 --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/test-instance.md @@ -0,0 +1,15 @@ +You need to run three sets of tests for SCIM integrations: + +1. SCIM API specification tests + + First, test your SCIM API service before you conduct Okta-SCIM integration tests. Okta provides you with a SCIM API specification test suite to execute in Runscope. See [Test your SCIM API](/docs/guides/scim-provisioning-integration-prepare/main/#test-your-scim-api) for instructions on how to run this test suite. Provide the test results URL in the **Link to Runscope spec test results** field when you submit your integration to the OIN. + +1. Runscope create, read, update, and delete (CRUD) user profile tests + + The Runscope CRUD test relies on your updated SCIM instance for testing. See [Runscope CRUD tests](/docs/guides/submit-oin-app/scim/main/#runscope-crud-tests) for instructions on how to run this test suite. Enter the results URL from these tests in the **Link to Runscope CRUD test results** field when you submit your integration to the OIN. + +1. Manual Okta SCIM integration tests + + See [Manual Okta SCIM integration tests](/docs/guides/submit-oin-app/scim/main/#manual-okta-scim-integration-tests) for instructions on how to run this test suite. There's no field in the OIN Wizard for the [Manual Okta SCIM integration tests](#manual-okta-scim-integration-tests) results, however, you must certify that you've completed these tests when you submit your integration to the OIN. + +> **Note:** Okta recommends that you execute the Runscope CRUD tests and the manual Okta SCIM integration tests on a published-version SCIM instance for backwards compatibility. The results of the backwards-compatibility tests aren't requirements for submission. diff --git a/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/test-steps.md b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/test-steps.md new file mode 100644 index 00000000000..8480fd626dc --- /dev/null +++ b/packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/test-steps.md @@ -0,0 +1,3 @@ +1. Generate an app instance from your updated integration. See [Generate instances for testing](#generate-instances-for-testing). + +1. Execute the Runscope CRUD and integration tests with your generated test instance. See [Test your integration](#test-your-integration). diff --git a/packages/@okta/vuepress-theme-prose/const/navbar.const.js b/packages/@okta/vuepress-theme-prose/const/navbar.const.js index 0de35483547..6c3358bc8d6 100644 --- a/packages/@okta/vuepress-theme-prose/const/navbar.const.js +++ b/packages/@okta/vuepress-theme-prose/const/navbar.const.js @@ -689,6 +689,10 @@ export const guides = [ title: "OIN Wizard: Submit an integration", guideName: "submit-oin-app", }, + { + title: "OIN Wizard: Update an integration", + guideName: "update-oin-app", + }, { title: "OIN Manager: Submit an integration", guideName: "submit-app",