session

Documentation

Index

• Constants
• func GetLocalCreds() (string, string, string, string, string)
• func NewRpcCredentials(in ...RpcCredentialsInput) tokenAuth
• type Option
  • func WithClientId(v string) Option
  • func WithClientSecret(v string) Option
  • func WithGrantType(v string) Option
  • func WithHttpClient(v *http.Client) Option
  • func WithLoginUrl(v string) Option
  • func WithPassword(v string) Option
  • func WithScope(v string) Option
  • func WithUsername(v string) Option
• type RpcCredentialsInput
• type Session
  • func New(o ...Option) *Session
  • func (s *Session) AccessToken() (string, error)
  • func (s *Session) ClientId() string
  • func (s *Session) ClientSecret() string
  • func (s *Session) GrantType() string
  • func (s *Session) LoginUrl() string
  • func (s *Session) Password() string
  • func (s *Session) Scope() string
  • func (s *Session) Username() string

Constants

const (
	LoginUrlRipple     = "https://login.alphaus.cloud/ripple/access_token"
	LoginUrlWave       = "https://login.alphaus.cloud/access_token"
	LoginUrlRippleNext = "https://loginnext.alphaus.cloud/ripple/access_token"
	LoginUrlWaveNext   = "https://loginnext.alphaus.cloud/access_token"
)

Functions

func GetLocalCreds

func GetLocalCreds() (string, string, string, string, string)

GetLocalCreds returns caller's id, secret, user, password, and login url.

func NewRpcCredentials

func NewRpcCredentials(in ...RpcCredentialsInput) tokenAuth

Types

type Option

type Option interface {
	Apply(*Session)
}

func WithClientId

func WithClientId(v string) Option

func WithClientSecret

func WithClientSecret(v string) Option

func WithGrantType

func WithGrantType(v string) Option

func WithHttpClient

func WithHttpClient(v *http.Client) Option

func WithLoginUrl

func WithLoginUrl(v string) Option

func WithPassword

func WithPassword(v string) Option

func WithScope

func WithScope(v string) Option

func WithUsername

func WithUsername(v string) Option

type RpcCredentialsInput

type RpcCredentialsInput struct {
	LoginUrl     string
	ClientId     string
	ClientSecret string
	AuthType     string // default: Bearer
	AccessToken  string // use directly if non-empty; disregard others
}

type Session

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

func New

func New(o ...Option) *Session

New returns a Session object for Blue API authentication.

func (*Session) AccessToken

func (s *Session) AccessToken() (string, error)

AccessToken returns the access token after successful authentication to Blue API.

func (*Session) ClientId

func (s *Session) ClientId() string

func (*Session) ClientSecret

func (s *Session) ClientSecret() string

func (*Session) GrantType

func (s *Session) GrantType() string

func (*Session) LoginUrl

func (s *Session) LoginUrl() string

func (*Session) Password

func (s *Session) Password() string

func (*Session) Scope

func (s *Session) Scope() string

func (*Session) Username

func (s *Session) Username() string