authtokens

Documentation

Index

• type AuthToken
• type AuthTokenDeleteResult
  • func (n AuthTokenDeleteResult) GetItem() any
  • func (n AuthTokenDeleteResult) GetResponse() *api.Response
• type AuthTokenListResult
  • func (n AuthTokenListResult) GetEstItemCount() uint
  • func (n AuthTokenListResult) GetItems() []*AuthToken
  • func (n AuthTokenListResult) GetListToken() string
  • func (n AuthTokenListResult) GetRemovedIds() []string
  • func (n AuthTokenListResult) GetResponse() *api.Response
  • func (n AuthTokenListResult) GetResponseType() string
• type AuthTokenReadResult
  • func (n AuthTokenReadResult) GetItem() *AuthToken
  • func (n AuthTokenReadResult) GetResponse() *api.Response
• type AuthTokenUpdateResult
• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) ApiClient() *api.Client
  • func (c *Client) Delete(ctx context.Context, id string, opt ...Option) (*AuthTokenDeleteResult, error)
  • func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*AuthTokenListResult, error)
  • func (c *Client) ListNextPage(ctx context.Context, currentPage *AuthTokenListResult, opt ...Option) (*AuthTokenListResult, error)
  • func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*AuthTokenReadResult, error)
• type Option
  • func WithClientDirectedPagination(with bool) Option
  • func WithFilter(filter string) Option
  • func WithListToken(listToken string) Option
  • func WithPageSize(with uint32) Option
  • func WithRecursive(recurse bool) Option
  • func WithResourcePathOverride(path string) Option
  • func WithSkipCurlOutput(skip bool) Option

Types

type AuthToken

type AuthToken struct {
	Id                      string            `json:"id,omitempty"`
	ScopeId                 string            `json:"scope_id,omitempty"`
	Scope                   *scopes.ScopeInfo `json:"scope,omitempty"`
	Token                   string            `json:"token,omitempty"`
	UserId                  string            `json:"user_id,omitempty"`
	AuthMethodId            string            `json:"auth_method_id,omitempty"`
	AccountId               string            `json:"account_id,omitempty"`
	CreatedTime             time.Time         `json:"created_time,omitempty"`
	UpdatedTime             time.Time         `json:"updated_time,omitempty"`
	ApproximateLastUsedTime time.Time         `json:"approximate_last_used_time,omitempty"`
	ExpirationTime          time.Time         `json:"expiration_time,omitempty"`
	AuthorizedActions       []string          `json:"authorized_actions,omitempty"`
}

type AuthTokenDeleteResult

type AuthTokenDeleteResult struct {
	Response *api.Response
}

func (AuthTokenDeleteResult) GetItem

func (n AuthTokenDeleteResult) GetItem() any

GetItem will always be nil for AuthTokenDeleteResult

func (AuthTokenDeleteResult) GetResponse

func (n AuthTokenDeleteResult) GetResponse() *api.Response

type AuthTokenListResult

type AuthTokenListResult struct {
	Items        []*AuthToken `json:"items,omitempty"`
	EstItemCount uint         `json:"est_item_count,omitempty"`
	RemovedIds   []string     `json:"removed_ids,omitempty"`
	ListToken    string       `json:"list_token,omitempty"`
	ResponseType string       `json:"response_type,omitempty"`
	Response     *api.Response
	// contains filtered or unexported fields
}

func (AuthTokenListResult) GetEstItemCount

func (n AuthTokenListResult) GetEstItemCount() uint

func (AuthTokenListResult) GetItems

func (n AuthTokenListResult) GetItems() []*AuthToken

func (AuthTokenListResult) GetListToken

func (n AuthTokenListResult) GetListToken() string

func (AuthTokenListResult) GetRemovedIds

func (n AuthTokenListResult) GetRemovedIds() []string

func (AuthTokenListResult) GetResponse

func (n AuthTokenListResult) GetResponse() *api.Response

func (AuthTokenListResult) GetResponseType

func (n AuthTokenListResult) GetResponseType() string

type AuthTokenReadResult

type AuthTokenReadResult struct {
	Item     *AuthToken
	Response *api.Response
}

func (AuthTokenReadResult) GetItem

func (n AuthTokenReadResult) GetItem() *AuthToken

func (AuthTokenReadResult) GetResponse

func (n AuthTokenReadResult) GetResponse() *api.Response

type AuthTokenUpdateResult

type AuthTokenUpdateResult = AuthTokenReadResult

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) Delete

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

func (*Client) List

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

func (*Client) ListNextPage

func (c *Client) ListNextPage(ctx context.Context, currentPage *AuthTokenListResult, opt ...Option) (*AuthTokenListResult, error)

func (*Client) Read

func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*AuthTokenReadResult, 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 the 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 WithClientDirectedPagination

func WithClientDirectedPagination(with bool) Option

WithClientDirectedPagination tells the List function to return only the first page, if more pages are available

func WithFilter

func WithFilter(filter string) Option

WithFilter tells the API to filter the items returned using the provided filter term. The filter should be in a format supported by hashicorp/go-bexpr.

func WithListToken

func WithListToken(listToken string) Option

WithListToken tells the API to use the provided list token for listing operations on this resource.

func WithPageSize

func WithPageSize(with uint32) Option

WithPageSize controls the size of pages used during List

func WithRecursive

func WithRecursive(recurse bool) Option

WithRecursive tells the API to use recursion for listing operations on this resource

func WithResourcePathOverride

func WithResourcePathOverride(path string) Option

WithResourcePathOverride tells the API to use the provided resource path

func WithSkipCurlOutput

func WithSkipCurlOutput(skip bool) Option

WithSkipCurlOutput tells the API to not use the current call for cURL output. Useful for when we need to look up versions.