client

Documentation

Index

• type Client
  • func NewClient(id, secret string, opts ...Option) *Client
  • func (c *Client) Token(scope oauth.Permissions, audience string) (*oauth.BearerToken, error)
• type Option
  • func WithBasePath(basePath string) Option
  • func WithClient(h *http.Client) Option
  • func WithHost(host string) Option
  • func WithScheme(scheme string) Option

Types

type Client

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

Client is a client for the oauth library

func NewClient

func NewClient(id, secret string, opts ...Option) *Client

NewClient returns a new oauth client, the defaults are primarily for testing purposes

func (*Client) Token

func (c *Client) Token(scope oauth.Permissions, audience string) (*oauth.BearerToken, error)

Token returns a client credentials token

type Option

type Option func(*Client)

Option is a client option method used to set proprties of the oauth client

func WithBasePath

func WithBasePath(basePath string) Option

WithBasePath sets the client basepath

func WithClient

func WithClient(h *http.Client) Option

WithClient sets the http client for the carmack api client

func WithHost

func WithHost(host string) Option

WithHost sets the host address

func WithScheme

func WithScheme(scheme string) Option

WithScheme sets the client scheme