Skip to content

feat: add note to TokenRevokeRequest and TokenRevokeResponse about 20-token-per-call limit #169

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.

Sign up for GitHub

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

Open
fabiohidekihirose wants to merge 3 commits into
base: master
Choose a base branch
from
+19 −1
Open

feat: add note to TokenRevokeRequest and TokenRevokeResponse about 20-token-per-call limit #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c58092
feat: add note to TokenRevokeRequest and TokenRevokeResponse about 20…
fabiohidekihirose Jun 19, 2026
105656c
fix: change markdown sintax to javadoc tags
fabiohidekihirose Jul 27, 2026
6024858
fix: update count description in TokenRevokeResponse
fabiohidekihirose Jul 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/main/java/com/authlete/common/dto/TokenRevokeRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@
* the API returns {@code 400 Bad Request}.
* </p>
* </ol>
*
* <p>
* Bulk revocation with {@code clientIdentifier} only, {@code clientIdentifier} + {@code subject},
* or {@code subject} only deletes at most {@code 20 tokens per request}
* (the default of {@code token.revoke.count.max} in {@code ServerConfiguration.java}). If the
* target has more than 20 tokens, the response {@code count} will be 20 and the remainder
* is left untouched. To fully wipe them, call the endpoint repeatedly until {@code count} returns 0.
* </p>
*
* @since 3.26
* @since Authlete 2.2.29
Expand Down
12 changes: 11 additions & 1 deletion src/main/java/com/authlete/common/dto/TokenRevokeResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,19 @@ public class TokenRevokeResponse extends ApiResponse
{
private static final long serialVersionUID = 1L;


/**
* The maximum amount of tokens that can be revoked per request is 20.
* If 20 is returned then additional token revocation requests should be made until this value
* is 0 to ensure that all tokens are revoked.
*/
private int count;

@rehanalam rehanalam Jul 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This note should also be added to the public getter/setter Javadocs, not only the private field.

@rehanalam rehanalam Jul 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@fabiohidekihirose



/**
* Get the number of revoked tokens.
* The maximum amount of tokens that can be revoked per request is 20.
* If 20 is returned then additional token revocation requests should be made until this value
* is 0 to ensure that all tokens are revoked.
*
* @return
* The number of revoked tokens.
Expand All @@ -44,6 +51,9 @@ public int getCount()

/**
* Set the number of revoked tokens.
* The maximum amount of tokens that can be revoked per request is 20.
* If 20 is returned then additional token revocation requests should be made until this value
* is 0 to ensure that all tokens are revoked.
*
* @param count
* The number of revoked tokens.
Expand Down