v1payload

Documentation

Index

• type Error
  • func (e Error) Cause() error
  • func (e Error) Error() string
• type GetJWTOutput
• type GetOAuthCredentialsInput
• type GetOAuthCredentialsOutput
• type GetWorkerJWTOutput
• type ListProjectsOutput
• type OAuthCredentials
• type Project
• type RefreshOAuthCredentialsInput
• type RefreshOAuthCredentialsOutput
• type RefreshWorkerJWTInput
• type RefreshWorkerJWTOutput

Types

type Error

type Error struct {
	Msg string `json:"error"`
}

Error is the error returned by the authentication server.

func (Error) Cause

func (e Error) Cause() error

Cause is implemented to be compatible with the pkg/errors package.

func (Error) Error

func (e Error) Error() string

Error returns the error message.

type GetJWTOutput

type GetJWTOutput struct {
	Token string `json:"token"`
}

GetJWTOutput is output when a JWT is requested

type GetOAuthCredentialsInput

type GetOAuthCredentialsInput struct {
	Code        string `url:"code"`
	ClientID    string `url:"client_id"`
	RedirectURI string `url:"redirect_uri"`
	GrantType   string `url:"grant_type"`
}

GetOAuthCredentialsInput is input for getting oauth credentials

type GetOAuthCredentialsOutput

type GetOAuthCredentialsOutput struct {
	OAuthCredentials
}

GetOAuthCredentialsOutput is output when getting oauth credentials

type GetWorkerJWTOutput

type GetWorkerJWTOutput struct {
	Token  string `json:"token"`
	Secret string `json:"secret"`
}

GetWorkerJWTOutput is output when a worker JWT (JWT + RefreshToken) is requested

type ListProjectsOutput

type ListProjectsOutput struct {
	Projects []Project
}

ListProjectsOutput contains a list of projects

type OAuthCredentials

type OAuthCredentials struct {
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token"`
	ExpiresIn    int    `json:"expires_in"`
	Scope        string `json:"scope,omitempty"`
	TokenType    string `json:"token_type,omitempty"`
}

OAuthCredentials represents the OAuth access tokens

type Project

type Project struct {
	ID   int    `json:"id"`
	URL  string `json:"url"`
	Code string `json:"code"`
}

Project represents a project

type RefreshOAuthCredentialsInput

type RefreshOAuthCredentialsInput struct {
	RefreshToken string `url:"refresh_token"`
	ClientID     string `url:"client_id"`
	GrantType    string `url:"grant_type"`
}

RefreshOAuthCredentialsInput is input for refreshing oauth credentials

type RefreshOAuthCredentialsOutput

type RefreshOAuthCredentialsOutput struct {
	OAuthCredentials
}

RefreshOAuthCredentialsOutput is output when refreshing oauth credentials

type RefreshWorkerJWTInput

type RefreshWorkerJWTInput struct {
	Token  string `json:"jwt"`
	Secret string `json:"secret"`
}

RefreshWorkerJWTInput is input for refreshing a JWT

type RefreshWorkerJWTOutput

type RefreshWorkerJWTOutput struct {
	Token string `json:"token"`
}

RefreshWorkerJWTOutput is output when a JWT refresh is requested