Interface IUserAccessTokenService
public interface IUserAccessTokenService
Service to operate user access tokens
- Since:
- 3.21.2
-
Method Summary
Modifier and TypeMethodDescriptionGenerates and persists a new user access tokengetUserAccessTokenByRawToken
(String rawToken) Gets a user access token's extended info via a raw token.getUserAccessTokens
(String userId) Gets a collection of existing user access tokensrenewToken
(String userId, String tokenId) Renews a user access tokenboolean
Revokes a user access tokenboolean
Revokes all access tokens from the given user
-
Method Details
-
generateUserAccessToken
Generates and persists a new user access token- Returns:
IUserAccessTokenBuilder
-
getUserAccessTokens
Gets a collection of existing user access tokens- Parameters:
userId
- ID of user that owns the token- Returns:
- A collection of
IUserAccessToken
-
getUserAccessTokenByRawToken
Gets a user access token's extended info via a raw token.- Parameters:
rawToken
- Raw user access token.- Returns:
- Valid user access token that corresponds to the raw token, if there is one.
-
revoke
Revokes a user access token- Parameters:
userId
- ID of user that owns the tokentokenId
- ID of user access token to be revoked- Returns:
true
if the token did exist
-
revokeAll
Revokes all access tokens from the given user- Parameters:
userId
- ID of user that owns the token- Returns:
true
if all tokens were revoked as a result of the call- Since:
- 3.22.1
-
renewToken
Renews a user access token- Parameters:
userId
- ID of user that owns the tokentokenId
- ID of user access token to be renewed- Returns:
- A renewed
IUserAccessToken
- Throws:
RuntimeException
- if fails to renew the token- Since:
- 3.24.4
-