Skip to content

OCI journey - OIE upgrade: API changes guide#6205

Open
brentschaus-okta wants to merge 11 commits into
masterfrom
tbs-okta-1185560-oie-upgrade-api-changes
Open

OCI journey - OIE upgrade: API changes guide#6205
brentschaus-okta wants to merge 11 commits into
masterfrom
tbs-okta-1185560-oie-upgrade-api-changes

Conversation

@brentschaus-okta

@brentschaus-okta brentschaus-okta commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

Description

What's changed?

Adds a new API changes after the upgrade guide (/docs/guides/oie-upgrade-api-changes/main/) documenting how specific Okta APIs behave differently or are unsupported after upgrading from Classic Engine to Identity Engine. Cross-links from related existing docs route readers to the new guide where relevant.

New guide: API changes after the upgrade

Covers three API areas with a summary table, per-section migration guidance, and an update checklist:

  • Authentication API: audience parameter not supported; device token behavior changed (migration path table)
  • Sessions API: cookieToken additional field not supported; /api/v1/sessions/me no longer returns IdP information
  • Factors API: email reset auto-enrollment behavior; question enrollment consolidation; SMS lifecycle operations not supported; password recovery limitations; Classic Engine API feature gaps

Cross-links added to related docs

  • Identity Engine limitations (docs/guides/ie-limitations/): Added an intro Note pointing to the new guide, plus per-section Further information links for email reset, question reset, Sessions APIs, SMS factors, the audience parameter, and password recovery.
  • Authentication API reference (docs/reference/api/authn/): Linked the deviceToken caution to the new guide's device token section; added an Identity Engine note at the IdP-initiated step-up section for the audience parameter; added a note at the Recovery operations section for Classic password recovery limitations. Also fixed a stray trailing > typo in the deviceToken caution.
  • Classic Engine MFA guide (docs/guides/mfa/): Added a Factors API changes link to the existing "If you're using Identity Engine" note.
  • Classic Engine session-cookie guide (docs/guides/session-cookie/): Added the Sessions API changes link alongside the existing session references.

Policy terminology fixes

Corrected mixed/incorrect policy names in both files:

  • ie-limitations: Changed "Okta sign-on policy" (Classic name used in an Identity Engine context) to "global session policy (called the Okta sign-on policy in Classic Engine)."
  • oie-upgrade-api-changes: Changed "Classic global sign-on policy" (not a real product term) to "Okta sign-on policy (called the global session policy in Identity Engine)."

Navbar and guide registry

  • Added oie-upgrade-api-changes to guides/index.md
  • Added "Okta API changes for OIE" entry to navbar.const.js (placed after Identity Engine limitations, before the event hooks entry)

Is this PR related to a Monolith release?
No. Targeting the July monthly developer docs release (code freeze June 26, 2026.07.0).

Resolves

Netlify preview link

Preview link

@okta-prod-github-app

This comment was marked as outdated.

@okta-prod-github-app

This comment was marked as outdated.

@okta-prod-github-app

This comment was marked as outdated.

@okta-prod-github-app

This comment was marked as outdated.

Add inbound links to the new "API changes after the upgrade" guide from
the Identity Engine limitations guide, the Authentication API reference,
and the Classic Engine MFA and session-cookie guides.
@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/ie-limitations/main/index.md 84 94 84 64
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/mfa/main/index.md 87 100 100 81
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/main/index.md 84 87 81 81
packages/@okta/vuepress-site/docs/guides/session-cookie/main/index.md 93 100 89 85

Successfully checked 6 of 6 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/ie-limitations/main/index.md 84 94 84 64
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/mfa/main/index.md 87 100 100 81
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/main/index.md 84 87 81 81
packages/@okta/vuepress-site/docs/guides/session-cookie/main/index.md 93 100 89 85

Successfully checked 6 of 6 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

@grahamsmith-okta grahamsmith-okta left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

a few notes and questions

Comment thread packages/@okta/vuepress-site/docs/guides/ie-limitations/main/index.md Outdated
Comment thread packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/main/index.md Outdated
Comment thread packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/main/index.md Outdated
brentschaus-okta and others added 2 commits June 25, 2026 16:33
…ndex.md

Co-authored-by: grahamsmith-okta <graham.smith@okta.com>
…es/main/index.md

Co-authored-by: grahamsmith-okta <graham.smith@okta.com>
@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/ie-limitations/main/index.md 84 94 84 64
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/mfa/main/index.md 87 100 100 81
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/main/index.md 84 87 81 81
packages/@okta/vuepress-site/docs/guides/session-cookie/main/index.md 93 100 89 85

Successfully checked 6 of 6 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/ie-limitations/main/index.md 84 94 84 64
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/mfa/main/index.md 87 100 100 81
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/main/index.md 84 87 81 81
packages/@okta/vuepress-site/docs/guides/session-cookie/main/index.md 93 100 89 85

Successfully checked 6 of 6 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

…1185560)

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/ie-limitations/main/index.md 84 94 84 64
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/mfa/main/index.md 87 100 100 81
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/main/index.md 84 87 81 81
packages/@okta/vuepress-site/docs/guides/session-cookie/main/index.md 93 100 89 85

Successfully checked 6 of 6 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/ie-limitations/main/index.md 85 94 85 65
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/mfa/main/index.md 87 100 100 81
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/main/index.md 84 87 81 81
packages/@okta/vuepress-site/docs/guides/session-cookie/main/index.md 93 100 89 85

Successfully checked 6 of 6 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

…-1185560)

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
@okta-prod-github-app

Copy link
Copy Markdown

Acrolinx score

A minimum Acrolinx Score of 80 is required. The total score is an average of the subscores.
Select Total score to review the Acrolinx scorecard for your article. Try to increase your individual scores, for example: Correctness. Your content will be clearer and more consistent.

Article Total score
Required:80
Word and phrases
(Brand, terms)
Preferred: 80
Correctness
(Spelling, grammar)
Preferred: 80
Clarity
(Readability)
Preferred: 80
Inclusive language
(+ accesibility)
Preferred: 80
packages/@okta/vuepress-site/docs/guides/ie-limitations/main/index.md 85 94 85 65
packages/@okta/vuepress-site/docs/guides/index.md 87 67 80 78
packages/@okta/vuepress-site/docs/guides/mfa/main/index.md 87 100 100 81
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/index.md 100 100 100 100
packages/@okta/vuepress-site/docs/guides/oie-upgrade-api-changes/main/index.md 84 87 81 81
packages/@okta/vuepress-site/docs/guides/session-cookie/main/index.md 93 100 89 85

Successfully checked 6 of 6 documents.
See summary in Content Analysis Dashboard

Reopen the pull request or push new changes to check again.

Depending on the Acrolinx server configuration, the
links expire after some time and you must have a login for the
Acrolinx server to access them again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants