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

update information about OAuth grant strategies #2488

Merged
merged 1 commit into from Jul 14, 2016

Conversation

sgallagher
Copy link

Modified from and replaces #1682

Supplements openshift/origin#9616

@sgallagher
Copy link
Author

@liggitt PTAL

@sgallagher
Copy link
Author

@stevekuznetsov PTAL also (since I based this on your original PR)

secret: "...", <2>
redirectURIs:
- http://www.example.com/ <3>
grantMethod: "...", <4>
Copy link

Choose a reason for hiding this comment

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

this looks like it's switching from json to invalid yaml

I would also make the sample data one of the valid values

grantMethod: prompt

@sgallagher
Copy link
Author

@liggitt Does this look better?

@liggitt
Copy link

liggitt commented Jul 14, 2016

yup, LGTM

----
<1> The `name` of the OAuth client is used as the `client_id` parameter when making requests to `_<master>_/oauth/authorize` and `_<master>_/oauth/token`.
<2> The `secret` is used as the `client_secret` parameter when making requests to `_<master>_/oauth/token`.
<3> The `redirect_uri` parameter specified in requests to `_<master>_/oauth/authorize` and `_<master>_/oauth/token` must be equal to (or prefixed by) one of the URIs in `redirectURIs`.
<4> The `grantMethod` is used to determine what action to take when this client requests tokens and has not yet been granted access by the user. Uses the same values seen in link:./../../install_config/configuring_authentication.html#grant-options[Grant Options].
Copy link
Contributor

Choose a reason for hiding this comment

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

We are now using xrefs instead of links for internal paths, so:
s/link:../../../install_config/configuring_authentication.html#grant-options[Grant Options]/xref:configuring_authentication.adoc#grant-options[Grant Options]

@ahardin-rh
Copy link
Contributor

@sgallagher just one little comment from me. Other than that, looks good!

@sgallagher
Copy link
Author

@ahardin-rh Updated, PTAL

@ahardin-rh
Copy link
Contributor

@sgallagher I messed up. Sorry! The path should still have install_config/ before it. So:
xref:../../../install_config/configuring_authentication.adoc#grant-options[Grant Options]

Sorry for the hassle! 😵

@ahardin-rh ahardin-rh self-assigned this Jul 14, 2016
@ahardin-rh
Copy link
Contributor

@sgallagher please also check my labels here. I am assuming this is for 3.3.

Signed-off-by: Stephen Gallagher <sgallagh@redhat.com>
@sgallagher
Copy link
Author

@ahardin-rh No problem. Fixed.

Yes, this is for 3.3 (it matches a feature added in that release).

@ahardin-rh
Copy link
Contributor

@sgallagher Perfect. Thanks!

@ahardin-rh ahardin-rh merged commit 4dbd0bc into openshift:master Jul 14, 2016
@ahardin-rh
Copy link
Contributor

ahardin-rh commented Jul 14, 2016

[rev_history]
|xref:../architecture/additional_concepts/authentication.adoc#oauth-clients[Additional Concepts -> Authentication]
|Added information about grantMethod.
%
|xref:../install_config/configuring_authentication.adoc#grant-options[Configuring Authentication]
|Updated OAuth grant strategies information.
%

@vikram-redhat vikram-redhat modified the milestones: OCP 3.3 GA, TEMP Oct 7, 2016
@vikram-redhat vikram-redhat modified the milestones: TEMP, OCP 3.3 GA Oct 7, 2016
@vikram-redhat vikram-redhat modified the milestones: OCP 3.3 GA, TEMP Nov 7, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants