authentication

Documentation

Index

• type ExternalAuthenticationError
  • func (e ExternalAuthenticationError) Error() string
• type GrantType
  • func (g GrantType) String() string
• type InvalidGrantTypeError
  • func NewInvalidGrantTypeError(description string) *InvalidGrantTypeError
  • func (e *InvalidGrantTypeError) Error() string
• type InvalidTokenError
  • func NewInvalidTokenError(description string) *InvalidTokenError
  • func (e *InvalidTokenError) Error() string
• type RefreshTokenExpiryError
  • func NewRefreshTokenExpiryError(description string) *RefreshTokenExpiryError
  • func (e *RefreshTokenExpiryError) Error() string
• type ResponseType
  • func (r ResponseType) String() string
• type ServerError
  • func NewServerError(statusCode int, errorCode string, description string) *ServerError
  • func (s *ServerError) Error() string
• type TokenOption
  • func SetResponseType(responseTypes ...ResponseType) TokenOption
  • func SetTokenParam(key, value string) TokenOption
• type TokenRequest
  • func NewTokenRequest(grantType GrantType) *TokenRequest
  • func (r *TokenRequest) GrantType() GrantType
  • func (r *TokenRequest) ResponseTypes() []ResponseType
  • func (r *TokenRequest) SetResponseType(responseTypes ...ResponseType)
  • func (r *TokenRequest) SetTokenParam(key, value string)
  • func (r *TokenRequest) SetValue(v url.Values)
  • func (r *TokenRequest) WithOption(opt TokenOption) *TokenRequest

Types

type ExternalAuthenticationError

type ExternalAuthenticationError struct {
	ErrorCode    string
	ErrorMessage string
}

func (ExternalAuthenticationError) Error

func (e ExternalAuthenticationError) Error() string

type GrantType

type GrantType string

func (GrantType) String

func (g GrantType) String() string

type InvalidGrantTypeError

type InvalidGrantTypeError struct {
	Description string
}

func NewInvalidGrantTypeError

func NewInvalidGrantTypeError(description string) *InvalidGrantTypeError

func (*InvalidGrantTypeError) Error

func (e *InvalidGrantTypeError) Error() string

type InvalidTokenError

type InvalidTokenError struct {
	Description string
}

func NewInvalidTokenError

func NewInvalidTokenError(description string) *InvalidTokenError

func (*InvalidTokenError) Error

func (e *InvalidTokenError) Error() string

type RefreshTokenExpiryError

type RefreshTokenExpiryError struct {
	Description string
}

RefreshTokenExpiryError is an error when provided refresh token expires. This error normally requires the client to re-login.

func NewRefreshTokenExpiryError

func NewRefreshTokenExpiryError(description string) *RefreshTokenExpiryError

NewRefreshTokenExpiryError creates a RefreshTokenExpiryError

func (*RefreshTokenExpiryError) Error

func (e *RefreshTokenExpiryError) Error() string

type ResponseType

type ResponseType string

func (ResponseType) String

func (r ResponseType) String() string

type ServerError

type ServerError struct {
	StatusCode  int
	ErrorCode   string
	Description string
}

func NewServerError

func NewServerError(statusCode int, errorCode string, description string) *ServerError

func (*ServerError) Error

func (s *ServerError) Error() string

type TokenOption

type TokenOption func(r *TokenRequest)

func SetResponseType

func SetResponseType(responseTypes ...ResponseType) TokenOption

func SetTokenParam

func SetTokenParam(key, value string) TokenOption

type TokenRequest

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

func NewTokenRequest

func NewTokenRequest(grantType GrantType) *TokenRequest

func (*TokenRequest) GrantType

func (r *TokenRequest) GrantType() GrantType

func (*TokenRequest) ResponseTypes

func (r *TokenRequest) ResponseTypes() []ResponseType

func (*TokenRequest) SetResponseType

func (r *TokenRequest) SetResponseType(responseTypes ...ResponseType)

func (*TokenRequest) SetTokenParam

func (r *TokenRequest) SetTokenParam(key, value string)

func (*TokenRequest) SetValue

func (r *TokenRequest) SetValue(v url.Values)

func (*TokenRequest) WithOption

func (r *TokenRequest) WithOption(opt TokenOption) *TokenRequest