auth

Documentation

Index

• func ValidateJwt(encodedJwt string) (jwt.Token, error)
• type Auth
  • func NewAuth(clientId, clientSecret, source, tokenIssuerUrl, audience string) *Auth
  • func (a *Auth) GetEnvironment() (string, error)
  • func (a *Auth) GetToken() (string, error)
• type Credentials
  • func LoadCredentials(fileLocation string) (Credentials, error)
  • func NewCredentials(audience, source, clientId, expiresAt, token string, refreshToken string) *Credentials
  • func (c *Credentials) GetEnvironment() (string, error)
  • func (c *Credentials) WriteCredentials(fileLocation string) error
• type DeviceTokenData
  • func GetDeviceCodeFromAuthorizationServer(clientId, scope, audience, authUrl string) (*DeviceTokenData, error)
• type ErrorResponse
• type SuccessfulResponse
  • func PollAuthorizationServerForResponse(cliClientId string, authUrl string, deviceTokenResponse *DeviceTokenData, ...) (*SuccessfulResponse, error)
  • func RefreshAuthToken(cliClientId string, authUrl string, refreshToken string, environmentId string) (*SuccessfulResponse, error)

Functions

func ValidateJwt

func ValidateJwt(encodedJwt string) (jwt.Token, error)

Types

type Auth

type Auth struct {
	// contains filtered or unexported fields
}

func NewAuth

func NewAuth(clientId, clientSecret, source, tokenIssuerUrl, audience string) *Auth

func (*Auth) GetEnvironment

func (a *Auth) GetEnvironment() (string, error)

func (*Auth) GetToken

func (a *Auth) GetToken() (string, error)

type Credentials

type Credentials struct {
	Audience     string `json:"audience"`
	Source       string `json:"source"`
	ClientId     string `json:"clientId"`
	ExpiresAt    string `json:"expiresAt"`
	Token        string `json:"token"`
	RefreshToken string `json:"refreshToken"`
}

func LoadCredentials

func LoadCredentials(fileLocation string) (Credentials, error)

func NewCredentials

func NewCredentials(audience, source, clientId, expiresAt, token string, refreshToken string) *Credentials

func (*Credentials) GetEnvironment

func (c *Credentials) GetEnvironment() (string, error)

func (*Credentials) WriteCredentials

func (c *Credentials) WriteCredentials(fileLocation string) error

type DeviceTokenData

type DeviceTokenData struct {
	DeviceCode              string `json:"device_code"`
	UserCode                string `json:"user_code"`
	VerificationUri         string `json:"verification_uri"`
	ExpiresIn               int    `json:"expires_in"`
	Interval                int    `json:"interval"`
	VerificationUriComplete string `json:"verification_uri_complete"`
}

func GetDeviceCodeFromAuthorizationServer

func GetDeviceCodeFromAuthorizationServer(clientId, scope, audience, authUrl string) (*DeviceTokenData, error)

type ErrorResponse

type ErrorResponse struct {
	Error       string `json:"error"`
	Description string `json:"error_description"`
}

type SuccessfulResponse

type SuccessfulResponse struct {
	// AccessToken Encoded JWT / Bearer Token
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token"`
	// SecondsUtilTokenExpires the number of seconds until the JWT expires, from when it was created by the Auth Server.
	// The JWT has the exact expiration date time
	SecondsUtilTokenExpires int `json:"expires_in"`
}

func PollAuthorizationServerForResponse

func PollAuthorizationServerForResponse(cliClientId string, authUrl string, deviceTokenResponse *DeviceTokenData, authStartedAt time.Time) (*SuccessfulResponse, error)

func RefreshAuthToken

func RefreshAuthToken(cliClientId string, authUrl string, refreshToken string, environmentId string) (*SuccessfulResponse, error)