auth

package

v0.1.27 Latest Latest Go to latest Published: Nov 23, 2022 License: MIT Imports: 22 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/danielmunro/otto-notification-service

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type BasicAuth
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type DefaultApiService
type GenericOpenAPIError
type GetSessionOpts

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	DefaultApi *DefaultApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Otto user service API v1.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration ¶

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

type DefaultApiService ¶

type DefaultApiService service

DefaultApiService DefaultApi service

func (*DefaultApiService) CreateNewSesssion ¶

func (a *DefaultApiService) CreateNewSesssion(ctx _context.Context, newSession model.NewSession) (model.Session, *_nethttp.Response, error)

CreateNewSesssion Create a new user session

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param newSession session to create

@return Session

func (*DefaultApiService) GetSession ¶

func (a *DefaultApiService) GetSession(ctx _context.Context, localVarOptionals *GetSessionOpts) (*_nethttp.Response, error)

GetSession Get a session

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param optional nil or *GetSessionOpts - Optional Parameters:
@param "Token" (optional.String) -

func (*DefaultApiService) GetUserV1 ¶

func (a *DefaultApiService) GetUserV1(ctx _context.Context) (model.User, *_nethttp.Response, error)

GetUserV1 Get a user

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return User

func (*DefaultApiService) UpdateUserSession ¶

func (a *DefaultApiService) UpdateUserSession(ctx _context.Context, sessionRefresh model.SessionRefresh) (*_nethttp.Response, error)

UpdateUserSession Update a user's session

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param sessionRefresh session to update

type GenericOpenAPIError ¶

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

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body ¶

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error ¶

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model ¶

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetSessionOpts ¶

type GetSessionOpts struct {
	Token optional.String
}

GetSessionOpts Optional parameters for the method 'GetSession'

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
model

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL