api service integration changes#5958
Merged
brentschaus-okta merged 20 commits intorelease-2026.03.0from Mar 4, 2026
Merged
Conversation
sophiajose-okta
requested review from
barbaravo-okta,
brentschaus-okta,
emikhasyak-okta,
grahamsmith-okta,
ishan-krishna-okta,
janethu-okta,
paulwallace-okta and
susanharper-okta
as code owners
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 7 of 7 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores. Successfully checked 11 of 11 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
sophiajose-okta
force-pushed
the
sj-okta-1091649
branch
from
92e7780 to
30cfac1
Compare
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores. Successfully checked 11 of 11 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores. Successfully checked 11 of 11 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
sophiajose-okta
added
the
docs release
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores. Successfully checked 11 of 11 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores. Successfully checked 11 of 11 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 12 of 12 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
sophiajose-okta
force-pushed
the
sj-okta-1091649
branch
from
f522142 to
40e44b6
Compare
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 12 of 12 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
sophiajose-okta
force-pushed
the
sj-okta-1091649
branch
from
40e44b6 to
de85d8b
Compare
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 12 of 12 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 25 of 25 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 25 of 25 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 25 of 25 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 25 of 25 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
vanngo-okta
reviewed
Feb 25, 2026
Contributor
vanngo-okta
left a comment
vanngo-okta
left a comment
There was a problem hiding this comment.
Some gaps in the API service integration guide flow. The more I read this, the more I think it might be good to separate this guide out, as the flow is challenging to use the template from the other capabilities.
packages/@okta/vuepress-site/docs/guides/update-oin-app/main/scim/edit-links.md
Outdated
Show resolved
Hide resolved
packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/index.md
Outdated
Show resolved
Hide resolved
| ## 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. | ||
| If you have a published Single Sign-On (SSO), lifecycle management, or API service integration in the [OIN catalog](https://www.okta.com/integrations/), you can update and resubmit it with the OIN Wizard. |
Contributor
There was a problem hiding this comment.
upapiservice folder for the "API Integration" slack selector in this "Update" guide. Are you sure you can edit the API service?
packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/index.md
Outdated
Show resolved
Hide resolved
|
|
||
| | Property | Description | | ||
| | --- | --- | | ||
| | Authentication properties | | |
Contributor
There was a problem hiding this comment.
Is this a property or heading? Maybe split this into a couple of tables with proper headings, since some information appears to be missing.
Contributor
Author
There was a problem hiding this comment.
The columns without descriptions are heading, since these are coming under API service properties, so I have removed these headings. Kept only the fields which need to be filled in.
| 4. Click **Done**. | ||
| 5. On the **General** tab, copy the **Okta domain** and **client ID** and securely store them for your integration test. | ||
| 6. Configure your app using the Okta domain, client ID, and client secret. | ||
| 7. Perform manual testing to verify your integration. |
Contributor
There was a problem hiding this comment.
This is a big ask of the user to verify their integration without any guidance on how to test it. Can you link to the testing procedure or guidance?
| 5. On the **General** tab, copy the **Okta domain** and **client ID** and securely store them for your integration test. | ||
| 6. Configure your app using the Okta domain, client ID, and client secret. | ||
| 7. Perform manual testing to verify your integration. | ||
| 8. Once the testing is complete, click **Continue to submission**. The **Test integration** page appears. |
Contributor
There was a problem hiding this comment.
This step is premature... there are a few sections after this line that talk about things you have to do BEFORE you click submit.
After this section, there is an "Assign test users to your integration instance" section - does this even apply to the API service integration??
There is also a "Submit your integration" section later on.
Contributor
Author
There was a problem hiding this comment.
Updated now
packages/@okta/vuepress-site/docs/guides/update-oin-app/main/openidconnect/edit-links.md
Outdated
Show resolved
Hide resolved
| > **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) | ||
| * [API service integration properties] | ||
| > **Note:** The API service integration is mutually exclusive. If you select the API service capability, you cannot select any other capability or protocol, such as SSO or Provisioning. Similarly, if you select another capability or protocol, the API service option is unavailable. |
| 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. |
Contributor
There was a problem hiding this comment.
Reference the other test sections???
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 38 of 38 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 97 of 97 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 97 of 97 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
sophiajose-okta
force-pushed
the
sj-okta-1091649
branch
from
30dedb2 to
95f3c02
Compare
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 97 of 97 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 117 of 117 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 120 of 120 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 120 of 120 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 120 of 120 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 120 of 120 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/openidconnect/add-tester.md
Outdated
Show resolved
Hide resolved
packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/openidconnect/add-tester.md
Outdated
Show resolved
Hide resolved
packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/openidconnect/add-tester.md
Outdated
Show resolved
Hide resolved
packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/openidconnect/add-tester.md
Outdated
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment.
My understanding is this:
- The OIN Wizard is for submitting an app to the OIN.
- When an org integrates the app from the OIN, they configure an app instance. They can add multiple instances of the same app.
- SSO is a capability that you can configure for an app instance. As far as I know, there's no such thing as an SSO instance.
Let me know if I got some of this wrong!
Contributor
Author
There was a problem hiding this comment.
I have checked your understanding with the SME for verification.
packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/openidconnect/assign-test.md
Outdated
Show resolved
Hide resolved
packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/openidconnect/assign-test.md
Outdated
Show resolved
Hide resolved
packages/@okta/vuepress-site/docs/guides/submit-oin-app/main/openidconnect/assign-test.md
Outdated
Show resolved
Hide resolved
|
|
||
| Before you start testing with the OIN Submission Tester, see [OIN Wizard test requirements](/docs/guides/submit-app-prereq/main/#oin-wizard-test-requirements). | ||
|
|
||
| > **Notes:** |
Contributor
There was a problem hiding this comment.
Can you either format this as a note or change the "Notes:" text to a full sentence?
Contributor
Author
There was a problem hiding this comment.
As discussed over slack.
|
|
||
| or the JIT provisioning test, the OIN Submission Tester creates a temporary Okta test user account for you to verify that JIT provisioning is successful. The OIN Submission Tester then removes the test user account from Okta to complete the test. | ||
|
|
||
| > **Notes:** |
Contributor
There was a problem hiding this comment.
Same notes comment as above.
Contributor
Author
There was a problem hiding this comment.
As discussed over slack.
Acrolinx scoreA minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Successfully checked 120 of 120 documents. Reopen the pull request or push new changes to check again. Depending on the Acrolinx server configuration, the |
barbaravo-okta
approved these changes
Feb 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description:
Resolves:
Netlify link:
https://preview-5958--reverent-murdock-829d24.netlify.app/docs/guides/update-oin-app/uapiservice/main/
https://preview-5958--reverent-murdock-829d24.netlify.app/docs/guides/submit-oin-app/uapiservice/main/
https://preview-5958--reverent-murdock-829d24.netlify.app/docs/guides/submit-app-overview/
https://preview-5958--reverent-murdock-829d24.netlify.app/docs/guides/submit-app/wfconnector/main/
https://preview-5958--reverent-murdock-829d24.netlify.app/docs/guides/oin-api-service-overview/
https://preview-5958--reverent-murdock-829d24.netlify.app/docs/guides/build-api-integration/main/