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

Documentation | Okta IDX API and Interaction Code flow #2952

Merged
merged 2 commits into from
Oct 28, 2024
Merged

Conversation

coldlink
Copy link
Member

@coldlink coldlink commented Oct 21, 2024

What does this change?

Add a whole bunch of documentation about the Okta Interaction Code Flow, and the Okta IDX API.

This includes information on how it works, why we're using it, it's usecase in Gateway too.

We also include reasoning as to why we're betting on passwordless (currently one-time passcodes).

It also documents all of the individual Okta IDX endpoints we're currently using within Gateway, as well as describing the flow on how the IDX API is set up for sign in (with passwords and passcodes), create account, and reset password flows.

This PR doesn't update the existing (some of it outdated) documentation, which will be done in a follow up PR.

The best way to review this PR would be to click "View File" when viewing the diff, in order to get a formatted view of the changes.

@coldlink coldlink force-pushed the mm/idx-docs branch 7 times, most recently from e0620c4 to d7981c3 Compare October 23, 2024 11:03
@coldlink coldlink added the passwordless PRs/Issues related to passwordless/passcode functionality label Oct 23, 2024
@coldlink coldlink force-pushed the mm/idx-docs branch 8 times, most recently from 221d02e to 84d8ed2 Compare October 28, 2024 09:40
@coldlink coldlink marked this pull request as ready for review October 28, 2024 09:40
@coldlink coldlink requested a review from a team as a code owner October 28, 2024 09:40
@coldlink coldlink changed the title Documentation | Okta IDX API Documentation | Okta IDX API and Interaction Code flow Oct 28, 2024
AshCorr
AshCorr previously approved these changes Oct 28, 2024
Copy link
Member

@AshCorr AshCorr left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for documenting all of this!

docs/okta/idx/idx-api.md Outdated Show resolved Hide resolved
Co-authored-by: AshCorr <ashcorr20@gmail.com>
Signed-off-by: Mahesh Makani <mahesh@makani.dev>
@coldlink coldlink merged commit 7a069d8 into main Oct 28, 2024
21 checks passed
@coldlink coldlink deleted the mm/idx-docs branch October 28, 2024 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
passwordless PRs/Issues related to passwordless/passcode functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants