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

/docs/idx.md misinformation #1444

Open
andyhills opened this issue Aug 3, 2023 · 0 comments
Open

/docs/idx.md misinformation #1444

andyhills opened this issue Aug 3, 2023 · 0 comments
Labels

Comments

@andyhills
Copy link

Describe the bug

In the /docs/idx.md walkthrough document, there are multiple references to the authenticators input for different idx methods/flows (e.g. authenticate, recoverPassword). However, this no longer seems to be the correct way to identify an authenticator. Instead, it seems that these flows are looking for the methodType input. This is based on what is returned by these methods in their nextStep attribute.

The various examples and snippets throughout the doc should be updated to reflect this.

Reproduction Steps?

For example, if you wanted to two a simple two factor authentication with PW + email, you might attempt something like the following based on the docs:

await oktaAuth.idx.authenticate({
          username: "[email protected]",
          password: "MyStrongPassword",
          authenticators: "okta_email",
          rememberMe: true
        });

However, if you were to follow the instructions in the nextStep returned from the initial flow setup method or the proceed function you would see that the actual input you must provide is methodType and the optional values follow a different pattern than suggested in the doc (e.g. "email" instead of "okta_email").

So instead, you would actually want to something like the following:

await oktaAuth.idx.authenticate({
          username: "[email protected]",
          password: "MyStrongPassword",
          methodType: "email",
          rememberMe: true
        });

And this would be the proper way to perform the authenticate action.

SDK Versions

All / Latest

Additional Information?

No response

@andyhills andyhills added the bug label Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant