authmethods

Documentation

Overview

Code generated by "make api"; DO NOT EDIT.

Code generated by "make api"; DO NOT EDIT.

Index

• type AuthMethod
  • func (n AuthMethod) ResponseBody() *bytes.Buffer
  • func (n AuthMethod) ResponseMap() map[string]interface{}
• type AuthMethodCreateResult
• type AuthMethodDeleteResult
  • func (n AuthMethodDeleteResult) GetResponseBody() *bytes.Buffer
  • func (n AuthMethodDeleteResult) GetResponseMap() map[string]interface{}
• type AuthMethodListResult
  • func (n AuthMethodListResult) GetItems() interface{}
  • func (n AuthMethodListResult) GetResponseBody() *bytes.Buffer
  • func (n AuthMethodListResult) GetResponseMap() map[string]interface{}
• type AuthMethodReadResult
  • func (n AuthMethodReadResult) GetItem() interface{}
  • func (n AuthMethodReadResult) GetResponseBody() *bytes.Buffer
  • func (n AuthMethodReadResult) GetResponseMap() map[string]interface{}
• type AuthMethodUpdateResult
• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) ApiClient() *api.Client
  • func (c *Client) Authenticate(ctx context.Context, authMethodId string, credentials map[string]interface{}, ...) (*authtokens.AuthTokenReadResult, error)
  • func (c *Client) Create(ctx context.Context, resourceType string, scopeId string, opt ...Option) (*AuthMethodCreateResult, error)
  • func (c *Client) Delete(ctx context.Context, authMethodId string, opt ...Option) (*AuthMethodDeleteResult, error)
  • func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*AuthMethodListResult, error)
  • func (c *Client) Read(ctx context.Context, authMethodId string, opt ...Option) (*AuthMethodReadResult, error)
  • func (c *Client) Update(ctx context.Context, authMethodId string, version uint32, opt ...Option) (*AuthMethodUpdateResult, error)
• type Option
  • func DefaultAttributes() Option
  • func DefaultDescription() Option
  • func DefaultName() Option
  • func DefaultPasswordAuthMethodMinLoginNameLength() Option
  • func DefaultPasswordAuthMethodMinPasswordLength() Option
  • func WithAttributes(inAttributes map[string]interface{}) Option
  • func WithAutomaticVersioning(enable bool) Option
  • func WithDescription(inDescription string) Option
  • func WithName(inName string) Option
  • func WithPasswordAuthMethodMinLoginNameLength(inMinLoginNameLength uint32) Option
  • func WithPasswordAuthMethodMinPasswordLength(inMinPasswordLength uint32) Option
• type PasswordAuthMethodAttributes

Types

type AuthMethod

type AuthMethod struct {
	Id          string                 `json:"id,omitempty"`
	ScopeId     string                 `json:"scope_id,omitempty"`
	Scope       *scopes.ScopeInfo      `json:"scope,omitempty"`
	Name        string                 `json:"name,omitempty"`
	Description string                 `json:"description,omitempty"`
	CreatedTime time.Time              `json:"created_time,omitempty"`
	UpdatedTime time.Time              `json:"updated_time,omitempty"`
	Version     uint32                 `json:"version,omitempty"`
	Type        string                 `json:"type,omitempty"`
	Attributes  map[string]interface{} `json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

func (AuthMethod) ResponseBody

func (n AuthMethod) ResponseBody() *bytes.Buffer

func (AuthMethod) ResponseMap

func (n AuthMethod) ResponseMap() map[string]interface{}

type AuthMethodCreateResult

type AuthMethodCreateResult = AuthMethodReadResult

type AuthMethodDeleteResult

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

func (AuthMethodDeleteResult) GetResponseBody

func (n AuthMethodDeleteResult) GetResponseBody() *bytes.Buffer

func (AuthMethodDeleteResult) GetResponseMap

func (n AuthMethodDeleteResult) GetResponseMap() map[string]interface{}

type AuthMethodListResult

type AuthMethodListResult struct {
	Items []*AuthMethod
	// contains filtered or unexported fields
}

func (AuthMethodListResult) GetItems

func (n AuthMethodListResult) GetItems() interface{}

func (AuthMethodListResult) GetResponseBody

func (n AuthMethodListResult) GetResponseBody() *bytes.Buffer

func (AuthMethodListResult) GetResponseMap

func (n AuthMethodListResult) GetResponseMap() map[string]interface{}

type AuthMethodReadResult

type AuthMethodReadResult struct {
	Item *AuthMethod
	// contains filtered or unexported fields
}

func (AuthMethodReadResult) GetItem

func (n AuthMethodReadResult) GetItem() interface{}

func (AuthMethodReadResult) GetResponseBody

func (n AuthMethodReadResult) GetResponseBody() *bytes.Buffer

func (AuthMethodReadResult) GetResponseMap

func (n AuthMethodReadResult) GetResponseMap() map[string]interface{}

type AuthMethodUpdateResult

type AuthMethodUpdateResult = AuthMethodReadResult

type Client

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

Client is a client for this collection

func NewClient

func NewClient(c *api.Client) *Client

Creates a new client for this collection. The submitted API client is cloned; modifications to it after generating this client will not have effect. If you need to make changes to the underlying API client, use ApiClient() to access it.

func (*Client) ApiClient

func (c *Client) ApiClient() *api.Client

ApiClient returns the underlying API client

func (*Client) Authenticate

func (c *Client) Authenticate(ctx context.Context, authMethodId string, credentials map[string]interface{}, opt ...Option) (*authtokens.AuthTokenReadResult, error)

func (*Client) Create

func (c *Client) Create(ctx context.Context, resourceType string, scopeId string, opt ...Option) (*AuthMethodCreateResult, error)

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, authMethodId string, opt ...Option) (*AuthMethodDeleteResult, error)

func (*Client) List

func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*AuthMethodListResult, error)

func (*Client) Read

func (c *Client) Read(ctx context.Context, authMethodId string, opt ...Option) (*AuthMethodReadResult, error)

func (*Client) Update

func (c *Client) Update(ctx context.Context, authMethodId string, version uint32, opt ...Option) (*AuthMethodUpdateResult, error)

type Option

type Option func(*options)

Option is a func that sets optional attributes for a call. This does not need to be used directly, but instead option arguments are built from the functions in this package. WithX options set a value to that given in the argument; DefaultX options indicate that the value should be set to its default. When an API call is made options are processed in ther order they appear in the function call, so for a given argument X, a succession of WithX or DefaultX calls will result in the last call taking effect.

func DefaultAttributes

func DefaultAttributes() Option

func DefaultDescription

func DefaultDescription() Option

func DefaultName

func DefaultName() Option

func DefaultPasswordAuthMethodMinLoginNameLength

func DefaultPasswordAuthMethodMinLoginNameLength() Option

func DefaultPasswordAuthMethodMinPasswordLength

func DefaultPasswordAuthMethodMinPasswordLength() Option

func WithAttributes

func WithAttributes(inAttributes map[string]interface{}) Option

func WithAutomaticVersioning

func WithAutomaticVersioning(enable bool) Option

If set, and if the version is zero during an update, the API will perform a fetch to get the current version of the resource and populate it during the update call. This is convenient but opens up the possibility for subtle order-of-modification issues, so use carefully.

func WithDescription

func WithDescription(inDescription string) Option

func WithName

func WithName(inName string) Option

func WithPasswordAuthMethodMinLoginNameLength

func WithPasswordAuthMethodMinLoginNameLength(inMinLoginNameLength uint32) Option

func WithPasswordAuthMethodMinPasswordLength

func WithPasswordAuthMethodMinPasswordLength(inMinPasswordLength uint32) Option

type PasswordAuthMethodAttributes

type PasswordAuthMethodAttributes struct {
	MinLoginNameLength uint32 `json:"min_login_name_length,omitempty"`
	MinPasswordLength  uint32 `json:"min_password_length,omitempty"`
}