Package org.apereo.cas.ticket.accesstoken

Interface OAuth20AccessToken

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 OAuth20AccessToken extends OAuth20Token
An access token is an OAuth token which can be used multiple times and has a long lifetime. It is used to access resources on behalf of a user and OAuth client.
Since:
5.0.0

  • Field Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getExpiresIn()
    Expiration time of the Access Token in seconds since the response was generated.
    String
    getIdToken()
    Gets id token.
    String
    getToken()
    Gets token or code that is exchanged for this access token.
    void
    setIdToken(String idToken)
    Sets id token.

    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

    • setIdToken

      void setIdToken(String idToken)
      Sets id token.
      Parameters:
      idToken - the id token

    • getIdToken

      String getIdToken()
      Gets id token.
      Returns:
      the id token

    • getToken

      String getToken()
      Gets token or code that is exchanged for this access token.
      Returns:
      the token

    • getExpiresIn

      long getExpiresIn()
      Expiration time of the Access Token in seconds since the response was generated.
      Returns:
      access token expiration in seconds