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

doc: clarify token revocation #2749

Merged
merged 4 commits into from
Mar 5, 2024

Conversation

peterhaochen47
Copy link
Member

No description provided.

@cf-gitbot
Copy link

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/187128281

The labels on this github issue will be updated when the story is started.

Copy link
Contributor

@bruce-ricard bruce-ricard left a comment

Choose a reason for hiding this comment

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

Maybe could you start the section by saying something like

Both access and refresh tokens can potentially be revoked

and add 2 subsections for each token type?

Sorry if I'm too nit-picky, I think that it's important to be precise and clear so that readers can't misunderstand what we are trying to explain.
But I technically agree with everything you wrote.

uaa/slateCustomizations/source/index.html.md.erb Outdated Show resolved Hide resolved
uaa/slateCustomizations/source/index.html.md.erb Outdated Show resolved Hide resolved
uaa/slateCustomizations/source/index.html.md.erb Outdated Show resolved Hide resolved
uaa/slateCustomizations/source/index.html.md.erb Outdated Show resolved Hide resolved
uaa/slateCustomizations/source/index.html.md.erb Outdated Show resolved Hide resolved
uaa/slateCustomizations/source/index.html.md.erb Outdated Show resolved Hide resolved
@peterhaochen47 peterhaochen47 force-pushed the pr/develop/improve-token-revocation-docs branch from cf91ed0 to a9bcdc7 Compare February 29, 2024 21:19
peterhaochen47 and others added 2 commits March 1, 2024 11:16
[#177045463]

Co-authored-by: Peter Chen <peter-h.chen@broadcom.com>
[#177045463]

Co-authored-by: Peter Chen <peter-h.chen@broadcom.com>
@peterhaochen47 peterhaochen47 force-pushed the pr/develop/improve-token-revocation-docs branch from a9bcdc7 to e072ab3 Compare March 1, 2024 19:16
Copy link
Contributor

@bruce-ricard bruce-ricard left a comment

Choose a reason for hiding this comment

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

Looks quite good! Just a couple thoughts added inline.

uaa/slateCustomizations/source/index.html.md.erb Outdated Show resolved Hide resolved
Comment on lines +404 to +407
Refresh tokens in any format can be revoked using the "Revoke all tokens for a user" endpoint (``/oauth/token/revoke/user/{userId}``),
the "Revoke all tokens for a client" endpoint (``/oauth/token/revoke/client/{clientId}``), or
the "Revoke all tokens for a user and client combination" endpoint (``/oauth/token/revoke/user/{userId}/client/{clientId}``).

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe link to the API docs could be useful for all the different endpoints?

Copy link
Member Author

Choose a reason for hiding this comment

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

I find that more than trivial to execute, but please feel free to make further improvements to the doc yourself.

@peterhaochen47 peterhaochen47 marked this pull request as ready for review March 1, 2024 22:31
@peterhaochen47 peterhaochen47 requested a review from a team March 1, 2024 22:33
Copy link
Member

@strehle strehle left a comment

Choose a reason for hiding this comment

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

Thanks.
We should think about to prevent JWT for refresh tokens but for now good doc

@peterhaochen47
Copy link
Member Author

Thanks. We should think about to prevent JWT for refresh tokens but for now good doc

Thanks! Yes, one issue filed here: cloudfoundry/uaa-release#813

@peterhaochen47 peterhaochen47 merged commit 78908b6 into develop Mar 5, 2024
20 checks passed
@peterhaochen47 peterhaochen47 deleted the pr/develop/improve-token-revocation-docs branch March 5, 2024 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants