Package org.apereo.cas.ticket.refreshtoken

Interface OAuth20RefreshToken

All Superinterfaces:
org.apereo.cas.ticket.AuthenticationAwareTicket, Comparable<org.apereo.cas.ticket.Ticket>, OAuth20Token, Serializable, org.apereo.cas.ticket.ServiceTicket, org.apereo.cas.ticket.Ticket, org.apereo.cas.ticket.TicketGrantingTicketAwareTicket
public interface OAuth20RefreshToken extends OAuth20Token
A refresh token is an OAuth token which can be used multiple times and has a very long lifetime. It is used to create new access tokens.
Since:
5.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PREFIX
    The prefix for refresh tokens.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Set<String>
    getAccessTokens()
    Gets descendant OAuth access tokens.

    Methods inherited from interface org.apereo.cas.ticket.AuthenticationAwareTicket

    getAuthentication

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface org.apereo.cas.ticket.OAuth20Token

    getClaims, getClientId, getGrantType, getResponseType, getScopes, isCode

    Methods inherited from interface org.apereo.cas.ticket.ServiceTicket

    getService

    Methods inherited from interface org.apereo.cas.ticket.Ticket

    getCountOfUses, getCreationTime, getExpirationPolicy, getId, getLastTimeUsed, getPrefix, getPreviousTimeUsed, isExpired, markTicketExpired, update

    Methods inherited from interface org.apereo.cas.ticket.TicketGrantingTicketAwareTicket

    getTicketGrantingTicket

  • Field Details

  • Method Details

    • getAccessTokens

      default Set<String> getAccessTokens()
      Gets descendant OAuth access tokens. The revocation of a refresh token may cause the revocation of related tokens and the underlying authorization grant. If a refresh token is revoked, the authorization server SHOULD also invalidate all access tokens based on the same authorization grant. Here, we track the access tokens.
      Returns:
      the access tokens
      Since:
      6.2