token

Documentation

Index

• func GetExpiry(tokenStr string, now time.Time) (expires bool, left time.Duration, err error)
• func GetUsername(tokenStr string) (username string, ok bool)
• func IsOrgAdmin(tokenStr string) bool
• func MapClaims(token *jwt.Token) (claims jwt.MapClaims, err error)
• func Parse(textToken string) (token *jwt.Token, err error)
• type Token
  • func (t *Token) IsValid() (tokenIsValid bool, err error)
  • func (t *Token) NeedsRefresh() bool

Functions

func GetExpiry

func GetExpiry(tokenStr string, now time.Time) (expires bool,
	left time.Duration, err error)

func GetUsername

func GetUsername(tokenStr string) (username string, ok bool)

GetUsername extracts the username claim value from the JWT

func IsOrgAdmin

func IsOrgAdmin(tokenStr string) bool

IsOrgAdmin returns the value of the `is_org_admin` claim

func MapClaims

func MapClaims(token *jwt.Token) (claims jwt.MapClaims, err error)

func Parse

func Parse(textToken string) (token *jwt.Token, err error)

Types

type Token

type Token struct {
	Logger       logging.Logger
	AccessToken  string `json:"access_token,omitempty" doc:"Bearer access token."`
	RefreshToken string `json:"refresh_token,omitempty" doc:"Offline or refresh token."`
}

Token contains the current access and refresh tokens from the Authorization server

func (*Token) IsValid

func (t *Token) IsValid() (tokenIsValid bool, err error)

func (*Token) NeedsRefresh

func (t *Token) NeedsRefresh() bool

NeedsRefresh checks if the access token is missing, expired or nearing expiry and should be refreshed