Documentation ¶
Overview ¶
Code generated by "make api"; DO NOT EDIT.
Code generated by "make api"; DO NOT EDIT.
Code generated by "make api"; DO NOT EDIT.
Code generated by "make api"; DO NOT EDIT.
Code generated by "make api"; DO NOT EDIT.
Code generated by "make api"; DO NOT EDIT.
Code generated by "make api"; DO NOT EDIT.
Code generated by "make api"; DO NOT EDIT.
Code generated by "make api"; DO NOT EDIT.
Code generated by "make api"; DO NOT EDIT.
Index ¶
- type Client
- func (c *Client) AddCredentialLibraries(ctx context.Context, id string, version uint32, opt ...Option) (*TargetUpdateResult, error)
- func (c *Client) AddCredentialSources(ctx context.Context, id string, version uint32, opt ...Option) (*TargetUpdateResult, error)
- func (c *Client) AddHostSets(ctx context.Context, id string, version uint32, hostSetIds []string, ...) (*TargetUpdateResult, error)
- func (c *Client) AddHostSources(ctx context.Context, id string, version uint32, hostSourceIds []string, ...) (*TargetUpdateResult, error)
- func (c *Client) ApiClient() *api.Client
- func (c *Client) AuthorizeSession(ctx context.Context, targetId string, opt ...Option) (*SessionAuthorizationResult, error)
- func (c *Client) Create(ctx context.Context, resourceType string, scopeId string, opt ...Option) (*TargetCreateResult, error)
- func (c *Client) Delete(ctx context.Context, id string, opt ...Option) (*TargetDeleteResult, error)
- func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*TargetListResult, error)
- func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*TargetReadResult, error)
- func (c *Client) RemoveCredentialLibraries(ctx context.Context, id string, version uint32, opt ...Option) (*TargetUpdateResult, error)
- func (c *Client) RemoveCredentialSources(ctx context.Context, id string, version uint32, opt ...Option) (*TargetUpdateResult, error)
- func (c *Client) RemoveHostSets(ctx context.Context, id string, version uint32, hostSetIds []string, ...) (*TargetUpdateResult, error)
- func (c *Client) RemoveHostSources(ctx context.Context, id string, version uint32, hostSourceIds []string, ...) (*TargetUpdateResult, error)
- func (c *Client) SetCredentialLibraries(ctx context.Context, id string, version uint32, opt ...Option) (*TargetUpdateResult, error)
- func (c *Client) SetCredentialSources(ctx context.Context, id string, version uint32, opt ...Option) (*TargetUpdateResult, error)
- func (c *Client) SetHostSets(ctx context.Context, id string, version uint32, hostSetIds []string, ...) (*TargetUpdateResult, error)
- func (c *Client) SetHostSources(ctx context.Context, id string, version uint32, hostSourceIds []string, ...) (*TargetUpdateResult, error)
- func (c *Client) Update(ctx context.Context, id string, version uint32, opt ...Option) (*TargetUpdateResult, error)
- type CredentialLibrary
- type CredentialSource
- type HostSet
- type HostSource
- type Option
- func DefaultApplicationCredentialLibraryIds() Option
- func DefaultApplicationCredentialSourceIds() Option
- func DefaultAttributes() Option
- func DefaultDescription() Option
- func DefaultEgressCredentialSourceIds() Option
- func DefaultName() Option
- func DefaultSessionConnectionLimit() Option
- func DefaultSessionMaxSeconds() Option
- func DefaultTcpTargetDefaultPort() Option
- func DefaultWorkerFilter() Option
- func WithApplicationCredentialLibraryIds(inApplicationCredentialLibraryIds []string) Option
- func WithApplicationCredentialSourceIds(inApplicationCredentialSourceIds []string) Option
- func WithAttributes(inAttributes map[string]interface{}) Option
- func WithAutomaticVersioning(enable bool) Option
- func WithDescription(inDescription string) Option
- func WithEgressCredentialSourceIds(inEgressCredentialSourceIds []string) Option
- func WithFilter(filter string) Option
- func WithHostId(inHostId string) Option
- func WithName(inName string) Option
- func WithRecursive(recurse bool) Option
- func WithScopeId(inScopeId string) Option
- func WithScopeName(inScopeName string) Option
- func WithSessionConnectionLimit(inSessionConnectionLimit int32) Option
- func WithSessionMaxSeconds(inSessionMaxSeconds uint32) Option
- func WithSkipCurlOutput(skip bool) Option
- func WithTcpTargetDefaultPort(inDefaultPort uint32) Option
- func WithWorkerFilter(inWorkerFilter string) Option
- type SessionAuthorization
- type SessionAuthorizationResult
- type SessionCredential
- type SessionSecret
- type Target
- type TargetCreateResult
- type TargetDeleteResult
- type TargetListResult
- type TargetReadResult
- type TargetUpdateResult
- type TcpTargetAttributes
- type WorkerInfo
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 ¶
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) AddCredentialLibraries ¶ added in v0.0.12
func (*Client) AddCredentialSources ¶ added in v0.0.15
func (*Client) AddHostSets ¶
func (*Client) AddHostSources ¶ added in v0.0.15
func (*Client) AuthorizeSession ¶
func (*Client) RemoveCredentialLibraries ¶ added in v0.0.12
func (*Client) RemoveCredentialSources ¶ added in v0.0.15
func (*Client) RemoveHostSets ¶
func (*Client) RemoveHostSources ¶ added in v0.0.15
func (*Client) SetCredentialLibraries ¶ added in v0.0.12
func (*Client) SetCredentialSources ¶ added in v0.0.15
func (*Client) SetHostSets ¶
func (*Client) SetHostSources ¶ added in v0.0.15
type CredentialLibrary ¶ added in v0.0.12
type CredentialSource ¶ added in v0.0.15
type CredentialSource struct { Id string `json:"id,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` CredentialStoreId string `json:"credential_store_id,omitempty"` Type string `json:"type,omitempty"` CredentialType string `json:"credential_type,omitempty"` }
type HostSource ¶ added in v0.0.15
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 DefaultApplicationCredentialLibraryIds ¶ added in v0.0.12
func DefaultApplicationCredentialLibraryIds() Option
func DefaultApplicationCredentialSourceIds ¶ added in v0.0.15
func DefaultApplicationCredentialSourceIds() Option
func DefaultAttributes ¶
func DefaultAttributes() Option
func DefaultDescription ¶
func DefaultDescription() Option
func DefaultEgressCredentialSourceIds ¶ added in v0.0.20
func DefaultEgressCredentialSourceIds() Option
func DefaultName ¶
func DefaultName() Option
func DefaultSessionConnectionLimit ¶
func DefaultSessionConnectionLimit() Option
func DefaultSessionMaxSeconds ¶
func DefaultSessionMaxSeconds() Option
func DefaultTcpTargetDefaultPort ¶
func DefaultTcpTargetDefaultPort() Option
func DefaultWorkerFilter ¶ added in v0.0.4
func DefaultWorkerFilter() Option
func WithApplicationCredentialLibraryIds ¶ added in v0.0.12
func WithApplicationCredentialSourceIds ¶ added in v0.0.15
func WithAttributes ¶
func WithAutomaticVersioning ¶
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 WithEgressCredentialSourceIds ¶ added in v0.0.20
func WithFilter ¶ added in v0.0.6
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 WithHostId ¶
func WithRecursive ¶ added in v0.0.4
WithRecursive tells the API to use recursion for listing operations on this resource
func WithScopeId ¶ added in v0.0.2
func WithScopeName ¶ added in v0.0.2
func WithSessionMaxSeconds ¶
func WithSkipCurlOutput ¶ added in v0.0.4
WithSkipCurlOutput tells the API to not use the current call for cURL output. Useful for when we need to look up versions.
func WithWorkerFilter ¶ added in v0.0.4
type SessionAuthorization ¶
type SessionAuthorization struct { SessionId string `json:"session_id,omitempty"` TargetId string `json:"target_id,omitempty"` Scope *scopes.ScopeInfo `json:"scope,omitempty"` CreatedTime time.Time `json:"created_time,omitempty"` UserId string `json:"user_id,omitempty"` HostSetId string `json:"host_set_id,omitempty"` HostId string `json:"host_id,omitempty"` Type string `json:"type,omitempty"` AuthorizationToken string `json:"authorization_token,omitempty"` Endpoint string `json:"endpoint,omitempty"` Credentials []*SessionCredential `json:"credentials,omitempty"` }
type SessionAuthorizationResult ¶
type SessionAuthorizationResult struct { Item *SessionAuthorization // contains filtered or unexported fields }
func (SessionAuthorizationResult) GetItem ¶
func (n SessionAuthorizationResult) GetItem() interface{}
func (SessionAuthorizationResult) GetResponse ¶ added in v0.0.7
func (n SessionAuthorizationResult) GetResponse() *api.Response
type SessionCredential ¶ added in v0.0.12
type SessionCredential struct { CredentialSource *CredentialSource `json:"credential_source,omitempty"` CredentialLibrary *CredentialLibrary `json:"credential_library,omitempty"` Secret *SessionSecret `json:"secret,omitempty"` Credential map[string]interface{} `json:"credential,omitempty"` }
type SessionSecret ¶ added in v0.0.13
type SessionSecret struct { Raw json.RawMessage `json:"raw,omitempty"` Decoded map[string]interface{} `json:"decoded,omitempty"` }
type Target ¶
type Target 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"` HostSetIds []string `json:"host_set_ids,omitempty"` HostSets []*HostSet `json:"host_sets,omitempty"` HostSourceIds []string `json:"host_source_ids,omitempty"` HostSources []*HostSource `json:"host_sources,omitempty"` SessionMaxSeconds uint32 `json:"session_max_seconds,omitempty"` SessionConnectionLimit int32 `json:"session_connection_limit,omitempty"` WorkerFilter string `json:"worker_filter,omitempty"` ApplicationCredentialLibraryIds []string `json:"application_credential_library_ids,omitempty"` ApplicationCredentialLibraries []*CredentialLibrary `json:"application_credential_libraries,omitempty"` ApplicationCredentialSourceIds []string `json:"application_credential_source_ids,omitempty"` ApplicationCredentialSources []*CredentialSource `json:"application_credential_sources,omitempty"` EgressCredentialSourceIds []string `json:"egress_credential_source_ids,omitempty"` EgressCredentialSources []*CredentialSource `json:"egress_credential_sources,omitempty"` Attributes map[string]interface{} `json:"attributes,omitempty"` AuthorizedActions []string `json:"authorized_actions,omitempty"` // contains filtered or unexported fields }
type TargetCreateResult ¶
type TargetCreateResult = TargetReadResult
type TargetDeleteResult ¶
type TargetDeleteResult struct {
// contains filtered or unexported fields
}
func (TargetDeleteResult) GetItem ¶ added in v0.0.10
func (n TargetDeleteResult) GetItem() interface{}
GetItem will always be nil for TargetDeleteResult
func (TargetDeleteResult) GetResponse ¶ added in v0.0.7
func (n TargetDeleteResult) GetResponse() *api.Response
type TargetListResult ¶
type TargetListResult struct { Items []*Target // contains filtered or unexported fields }
func (TargetListResult) GetItems ¶
func (n TargetListResult) GetItems() interface{}
func (TargetListResult) GetResponse ¶ added in v0.0.7
func (n TargetListResult) GetResponse() *api.Response
type TargetReadResult ¶
type TargetReadResult struct { Item *Target // contains filtered or unexported fields }
func (TargetReadResult) GetItem ¶
func (n TargetReadResult) GetItem() interface{}
func (TargetReadResult) GetResponse ¶ added in v0.0.7
func (n TargetReadResult) GetResponse() *api.Response
type TargetUpdateResult ¶
type TargetUpdateResult = TargetReadResult
type TcpTargetAttributes ¶
type TcpTargetAttributes struct {
DefaultPort uint32 `json:"default_port,omitempty"`
}
type WorkerInfo ¶
type WorkerInfo struct {
Address string `json:"address,omitempty"`
}