credentialstores

package
v0.0.51 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 30, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

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

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

func (*Client) Delete

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

func (*Client) List

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

func (*Client) Read

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

func (*Client) Update

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

type CredentialStore

type CredentialStore 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"`
	AuthorizedActions           []string               `json:"authorized_actions,omitempty"`
	AuthorizedCollectionActions map[string][]string    `json:"authorized_collection_actions,omitempty"`
}

func (*CredentialStore) GetVaultCredentialStoreAttributes added in v0.0.26

func (pt *CredentialStore) GetVaultCredentialStoreAttributes() (*VaultCredentialStoreAttributes, error)

type CredentialStoreCreateResult

type CredentialStoreCreateResult = CredentialStoreReadResult

type CredentialStoreDeleteResult

type CredentialStoreDeleteResult struct {
	Response *api.Response
}

func (CredentialStoreDeleteResult) GetItem

func (n CredentialStoreDeleteResult) GetItem() interface{}

GetItem will always be nil for CredentialStoreDeleteResult

func (CredentialStoreDeleteResult) GetResponse

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

type CredentialStoreListResult

type CredentialStoreListResult struct {
	Items        []*CredentialStore `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
}

func (CredentialStoreListResult) GetEstItemCount added in v0.0.44

func (n CredentialStoreListResult) GetEstItemCount() uint

func (CredentialStoreListResult) GetItems

func (CredentialStoreListResult) GetListToken added in v0.0.44

func (n CredentialStoreListResult) GetListToken() string

func (CredentialStoreListResult) GetRemovedIds added in v0.0.44

func (n CredentialStoreListResult) GetRemovedIds() []string

func (CredentialStoreListResult) GetResponse

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

func (CredentialStoreListResult) GetResponseType added in v0.0.44

func (n CredentialStoreListResult) GetResponseType() string

type CredentialStoreReadResult

type CredentialStoreReadResult struct {
	Item     *CredentialStore
	Response *api.Response
}

func (CredentialStoreReadResult) GetItem

func (CredentialStoreReadResult) GetResponse

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

type CredentialStoreUpdateResult

type CredentialStoreUpdateResult = CredentialStoreReadResult

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 DefaultAttributes

func DefaultAttributes() Option

func DefaultDescription

func DefaultDescription() Option

func DefaultName

func DefaultName() Option

func DefaultVaultCredentialStoreCaCert

func DefaultVaultCredentialStoreCaCert() Option

func DefaultVaultCredentialStoreClientCertificate

func DefaultVaultCredentialStoreClientCertificate() Option

func DefaultVaultCredentialStoreClientCertificateKey

func DefaultVaultCredentialStoreClientCertificateKey() Option

func DefaultVaultCredentialStoreNamespace

func DefaultVaultCredentialStoreNamespace() Option

func DefaultVaultCredentialStoreTlsServerName

func DefaultVaultCredentialStoreTlsServerName() Option

func DefaultVaultCredentialStoreTlsSkipVerify

func DefaultVaultCredentialStoreTlsSkipVerify() Option

func DefaultVaultCredentialStoreWorkerFilter added in v0.0.26

func DefaultVaultCredentialStoreWorkerFilter() 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 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 added in v0.0.44

func WithListToken(listToken string) Option

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

func WithName

func WithName(inName string) Option

func WithRecursive

func WithRecursive(recurse bool) Option

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

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.

func WithVaultCredentialStoreAddress

func WithVaultCredentialStoreAddress(inAddress string) Option

func WithVaultCredentialStoreCaCert

func WithVaultCredentialStoreCaCert(inCaCert string) Option

func WithVaultCredentialStoreClientCertificate

func WithVaultCredentialStoreClientCertificate(inClientCertificate string) Option

func WithVaultCredentialStoreClientCertificateKey

func WithVaultCredentialStoreClientCertificateKey(inClientCertificateKey string) Option

func WithVaultCredentialStoreNamespace

func WithVaultCredentialStoreNamespace(inNamespace string) Option

func WithVaultCredentialStoreTlsServerName

func WithVaultCredentialStoreTlsServerName(inTlsServerName string) Option

func WithVaultCredentialStoreTlsSkipVerify

func WithVaultCredentialStoreTlsSkipVerify(inTlsSkipVerify bool) Option

func WithVaultCredentialStoreToken

func WithVaultCredentialStoreToken(inToken string) Option

func WithVaultCredentialStoreWorkerFilter added in v0.0.26

func WithVaultCredentialStoreWorkerFilter(inWorkerFilter string) Option

type VaultCredentialStoreAttributes

type VaultCredentialStoreAttributes struct {
	Address                  string `json:"address,omitempty"`
	Namespace                string `json:"namespace,omitempty"`
	CaCert                   string `json:"ca_cert,omitempty"`
	TlsServerName            string `json:"tls_server_name,omitempty"`
	TlsSkipVerify            bool   `json:"tls_skip_verify,omitempty"`
	Token                    string `json:"token,omitempty"`
	TokenHmac                string `json:"token_hmac,omitempty"`
	ClientCertificate        string `json:"client_certificate,omitempty"`
	ClientCertificateKey     string `json:"client_certificate_key,omitempty"`
	ClientCertificateKeyHmac string `json:"client_certificate_key_hmac,omitempty"`
	WorkerFilter             string `json:"worker_filter,omitempty"`
	TokenStatus              string `json:"token_status,omitempty"`
}

func AttributesMapToVaultCredentialStoreAttributes added in v0.0.26

func AttributesMapToVaultCredentialStoreAttributes(in map[string]interface{}) (*VaultCredentialStoreAttributes, error)

Jump to

Keyboard shortcuts

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