credentiallibraries

package
v0.0.53 Latest Latest
Warning

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

 Go to latest Published: Sep 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, credentialStoreId string, opt ...Option) (*CredentialLibraryCreateResult, error)

func (*Client) Delete 

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

func (*Client) List 

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

func (*Client) ListNextPage added in v0.0.53 

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

func (*Client) Read 

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

func (*Client) Update 

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

type CredentialLibrary 

type CredentialLibrary struct {
	Id                         string                 `json:"id,omitempty"`
	CredentialStoreId          string                 `json:"credential_store_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"`
	CredentialType             string                 `json:"credential_type,omitempty"`
	CredentialMappingOverrides map[string]interface{} `json:"credential_mapping_overrides,omitempty"`
}

func (*CredentialLibrary) GetVaultCredentialLibraryAttributes added in v0.0.26 

func (pt *CredentialLibrary) GetVaultCredentialLibraryAttributes() (*VaultCredentialLibraryAttributes, error)

func (*CredentialLibrary) GetVaultSSHCertificateCredentialLibraryAttributes added in v0.0.34 

func (pt *CredentialLibrary) GetVaultSSHCertificateCredentialLibraryAttributes() (*VaultSSHCertificateCredentialLibraryAttributes, error)

type CredentialLibraryCreateResult 

type CredentialLibraryCreateResult = CredentialLibraryReadResult

type CredentialLibraryDeleteResult 

type CredentialLibraryDeleteResult struct {
	Response *api.Response
}

func (CredentialLibraryDeleteResult) GetItem 

func (n CredentialLibraryDeleteResult) GetItem() any

GetItem will always be nil for CredentialLibraryDeleteResult

func (CredentialLibraryDeleteResult) GetResponse 

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

type CredentialLibraryListResult 

type CredentialLibraryListResult struct {
	Items        []*CredentialLibrary `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 (CredentialLibraryListResult) GetEstItemCount added in v0.0.44 

func (n CredentialLibraryListResult) GetEstItemCount() uint

func (CredentialLibraryListResult) GetItems 

func (n CredentialLibraryListResult) GetItems() []*CredentialLibrary

func (CredentialLibraryListResult) GetListToken added in v0.0.44 

func (n CredentialLibraryListResult) GetListToken() string

func (CredentialLibraryListResult) GetRemovedIds added in v0.0.44 

func (n CredentialLibraryListResult) GetRemovedIds() []string

func (CredentialLibraryListResult) GetResponse 

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

func (CredentialLibraryListResult) GetResponseType added in v0.0.44 

func (n CredentialLibraryListResult) GetResponseType() string

type CredentialLibraryReadResult 

type CredentialLibraryReadResult struct {
	Item     *CredentialLibrary
	Response *api.Response
}

func (CredentialLibraryReadResult) GetItem 

func (n CredentialLibraryReadResult) GetItem() *CredentialLibrary

func (CredentialLibraryReadResult) GetResponse 

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

type CredentialLibraryUpdateResult 

type CredentialLibraryUpdateResult = CredentialLibraryReadResult

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 DefaultCredentialMappingOverrides added in v0.0.21 

func DefaultCredentialMappingOverrides() Option

func DefaultCredentialType added in v0.0.21 

func DefaultCredentialType() Option

func DefaultDescription 

func DefaultDescription() Option

func DefaultName 

func DefaultName() Option

func DefaultVaultCredentialLibraryHttpMethod 

func DefaultVaultCredentialLibraryHttpMethod() Option

func DefaultVaultCredentialLibraryHttpRequestBody 

func DefaultVaultCredentialLibraryHttpRequestBody() Option

func DefaultVaultSSHCertificateCredentialLibraryAdditionalValidPrincipals added in v0.0.42 

func DefaultVaultSSHCertificateCredentialLibraryAdditionalValidPrincipals() Option

func DefaultVaultSSHCertificateCredentialLibraryCriticalOptions added in v0.0.34 

func DefaultVaultSSHCertificateCredentialLibraryCriticalOptions() Option

func DefaultVaultSSHCertificateCredentialLibraryExtensions added in v0.0.34 

func DefaultVaultSSHCertificateCredentialLibraryExtensions() Option

func DefaultVaultSSHCertificateCredentialLibraryKeyBits added in v0.0.34 

func DefaultVaultSSHCertificateCredentialLibraryKeyBits() Option

func DefaultVaultSSHCertificateCredentialLibraryKeyId added in v0.0.34 

func DefaultVaultSSHCertificateCredentialLibraryKeyId() Option

func DefaultVaultSSHCertificateCredentialLibraryKeyType added in v0.0.34 

func DefaultVaultSSHCertificateCredentialLibraryKeyType() Option

func DefaultVaultSSHCertificateCredentialLibraryTtl added in v0.0.34 

func DefaultVaultSSHCertificateCredentialLibraryTtl() 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 WithClientDirectedPagination added in v0.0.53 

func WithClientDirectedPagination(with bool) Option

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

func WithCredentialMappingOverrides added in v0.0.21 

func WithCredentialMappingOverrides(inCredentialMappingOverrides map[string]interface{}) Option

func WithCredentialType added in v0.0.21 

func WithCredentialType(inCredentialType string) Option

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 WithPageSize added in v0.0.53 

func WithPageSize(with uint32) Option

WithPageSize controls the size of pages used during List

func WithResourcePathOverride added in v0.0.53 

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.

func WithVaultCredentialLibraryHttpMethod 

func WithVaultCredentialLibraryHttpMethod(inHttpMethod string) Option

func WithVaultCredentialLibraryHttpRequestBody 

func WithVaultCredentialLibraryHttpRequestBody(inHttpRequestBody string) Option

func WithVaultCredentialLibraryPath 

func WithVaultCredentialLibraryPath(inPath string) Option

func WithVaultSSHCertificateCredentialLibraryAdditionalValidPrincipals added in v0.0.42 

func WithVaultSSHCertificateCredentialLibraryAdditionalValidPrincipals(inAdditionalValidPrincipals []string) Option

func WithVaultSSHCertificateCredentialLibraryCriticalOptions added in v0.0.34 

func WithVaultSSHCertificateCredentialLibraryCriticalOptions(inCriticalOptions map[string]string) Option

func WithVaultSSHCertificateCredentialLibraryExtensions added in v0.0.34 

func WithVaultSSHCertificateCredentialLibraryExtensions(inExtensions map[string]string) Option

func WithVaultSSHCertificateCredentialLibraryKeyBits added in v0.0.34 

func WithVaultSSHCertificateCredentialLibraryKeyBits(inKeyBits uint32) Option

func WithVaultSSHCertificateCredentialLibraryKeyId added in v0.0.34 

func WithVaultSSHCertificateCredentialLibraryKeyId(inKeyId string) Option

func WithVaultSSHCertificateCredentialLibraryKeyType added in v0.0.34 

func WithVaultSSHCertificateCredentialLibraryKeyType(inKeyType string) Option

func WithVaultSSHCertificateCredentialLibraryPath added in v0.0.34 

func WithVaultSSHCertificateCredentialLibraryPath(inPath string) Option

func WithVaultSSHCertificateCredentialLibraryTtl added in v0.0.34 

func WithVaultSSHCertificateCredentialLibraryTtl(inTtl string) Option

func WithVaultSSHCertificateCredentialLibraryUsername added in v0.0.34 

func WithVaultSSHCertificateCredentialLibraryUsername(inUsername string) Option

type VaultCredentialLibraryAttributes 

type VaultCredentialLibraryAttributes struct {
	Path            string `json:"path,omitempty"`
	HttpMethod      string `json:"http_method,omitempty"`
	HttpRequestBody string `json:"http_request_body,omitempty"`
}

func AttributesMapToVaultCredentialLibraryAttributes added in v0.0.26 

func AttributesMapToVaultCredentialLibraryAttributes(in map[string]any) (*VaultCredentialLibraryAttributes, error)

type VaultSSHCertificateCredentialLibraryAttributes added in v0.0.34 

type VaultSSHCertificateCredentialLibraryAttributes struct {
	Path                      string            `json:"path,omitempty"`
	Username                  string            `json:"username,omitempty"`
	KeyType                   string            `json:"key_type,omitempty"`
	KeyBits                   uint32            `json:"key_bits,omitempty"`
	Ttl                       string            `json:"ttl,omitempty"`
	KeyId                     string            `json:"key_id,omitempty"`
	CriticalOptions           map[string]string `json:"critical_options,omitempty"`
	Extensions                map[string]string `json:"extensions,omitempty"`
	AdditionalValidPrincipals []string          `json:"additional_valid_principals,omitempty"`
}

func AttributesMapToVaultSSHCertificateCredentialLibraryAttributes added in v0.0.34 

func AttributesMapToVaultSSHCertificateCredentialLibraryAttributes(in map[string]any) (*VaultSSHCertificateCredentialLibraryAttributes, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.