oidctypes

Documentation

Overview

Package oidctypes provides core data types for OIDC token structures.

Index

• type AccessToken
• type IDToken
• type RefreshToken
• type Token

Types

type AccessToken

type AccessToken struct {
	// Token is the token that authorizes and authenticates the requests.
	Token string `json:"token"`

	// Type is the type of token.
	Type string `json:"type,omitempty"`

	// Expiry is the optional expiration time of the access token.
	Expiry v1.Time `json:"expiryTimestamp,omitempty"`
}

AccessToken is an OAuth2 access token.

type IDToken

type IDToken struct {
	// Token is an OpenID Connect ID token.
	Token string `json:"token"`

	// Expiry is the optional expiration time of the ID token.
	Expiry v1.Time `json:"expiryTimestamp,omitempty"`

	// Claims are the claims expressed by the Token.
	Claims map[string]interface{} `json:"claims,omitempty"`
}

IDToken is an OpenID Connect ID token.

type RefreshToken

type RefreshToken struct {
	// Token is a token that's used by the application (as opposed to the user) to refresh the access token if it expires.
	Token string `json:"token"`
}

RefreshToken is an OAuth2 refresh token.

type Token

type Token struct {
	// AccessToken is the token that authorizes and authenticates the requests.
	AccessToken *AccessToken `json:"access,omitempty"`

	// RefreshToken is a token that's used by the application
	// (as opposed to the user) to refresh the access token
	// if it expires.
	RefreshToken *RefreshToken `json:"refresh,omitempty"`

	// IDToken is an OpenID Connect ID token.
	IDToken *IDToken `json:"id,omitempty"`
}

Token contains the elements of an OIDC session.