IUserAccessTokenService

public interface IUserAccessTokenService

Service to operate user access tokens

Since:: 3.21.2

Method Summary

Modifier and Type

Method

Description

IUserAccessTokenBuilder

generateUserAccessToken()

Generates and persists a new user access token

Optional<IUserAccessToken>

getUserAccessTokenByRawToken(String rawToken)

Gets a user access token's extended info via a raw token.

Set<IUserAccessToken>

getUserAccessTokens(String userId)

Gets a collection of existing user access tokens

boolean

revoke(String userId, String tokenId)

Revokes a user access token

boolean

revokeAll(String userId)

Revokes all access tokens from the given user

Method Details
- generateUserAccessToken
  
  @NotNull IUserAccessTokenBuilder generateUserAccessToken()
  
  Generates and persists a new user access token
  
  Returns:
  
  IUserAccessTokenBuilder
- getUserAccessTokens
  
  @NotNull Set<IUserAccessToken> getUserAccessTokens(@NotNull String userId)
  
  Gets a collection of existing user access tokens
  
  Parameters:
  
  userId - ID of user that owns the token
  
  Returns:
  
  A collection of IUserAccessToken
- getUserAccessTokenByRawToken
  
  @NotNull Optional<IUserAccessToken> getUserAccessTokenByRawToken(@NotNull String rawToken)
  
  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
  
  boolean revoke(@NotNull String userId, @NotNull String tokenId)
  
  Revokes a user access token
  
  Parameters:
  
  userId - ID of user that owns the token
  
  tokenId - ID of user access token to be revoked
  
  Returns:
  
  true if the token did exist
- revokeAll
  
  boolean revokeAll(@NotNull String userId)
  
  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