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

Implicit Grant Flow Documentation is Incorrect #286

Closed
spotthecow opened this issue Sep 12, 2024 · 1 comment
Closed

Implicit Grant Flow Documentation is Incorrect #286

spotthecow opened this issue Sep 12, 2024 · 1 comment

Comments

@spotthecow
Copy link

The documentation for the implicit grant flow is incorrect and it is unclear how to use this crate for the implicit grant flow. The implicit grant flow does not use a client secret, yet the example in the doc includes one. The implicit grant flow also DOES require a redirect uri, but the example does NOT include one. I would submit a PR to fix the doc, but I'm struggling to figure out how to use this crate for this flow.

@ramosbugs
Copy link
Owner

The implicit grant flow does not use a client secret, yet the example in the doc includes one.

Ah yes, good catch. The secret doesn't get used for anything, but it shouldn't be part of the example.

The implicit grant flow also DOES require a redirect uri, but the example does NOT include one.

No, the redirect_uri is optional. If omitted, the server should use the redirect URI previously configured for use with the provided client ID.

In any case, if you look at the docs beyond the examples, you'll see a set_redirect_uri method for this purpose. The examples are intended as a starting point; not a replacement for referencing the complete API documentation.

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

No branches or pull requests

2 participants