managedgroups

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: 11 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, authMethodId string, opt ...Option) (*ManagedGroupCreateResult, error)

func (*Client) Delete 

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

func (*Client) List 

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

func (*Client) Read 

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

func (*Client) Update 

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

type LdapManagedGroupAttributes added in v0.0.35 

type LdapManagedGroupAttributes struct {
	GroupNames []string `json:"group_names,omitempty"`
}

func AttributesMapToLdapManagedGroupAttributes added in v0.0.35 

func AttributesMapToLdapManagedGroupAttributes(in map[string]interface{}) (*LdapManagedGroupAttributes, error)

type ManagedGroup 

type ManagedGroup struct {
	Id                string                 `json:"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"`
	AuthMethodId      string                 `json:"auth_method_id,omitempty"`
	Attributes        map[string]interface{} `json:"attributes,omitempty"`
	MemberIds         []string               `json:"member_ids,omitempty"`
	AuthorizedActions []string               `json:"authorized_actions,omitempty"`
}

func (*ManagedGroup) GetLdapManagedGroupAttributes added in v0.0.35 

func (pt *ManagedGroup) GetLdapManagedGroupAttributes() (*LdapManagedGroupAttributes, error)

func (*ManagedGroup) GetOidcManagedGroupAttributes added in v0.0.26 

func (pt *ManagedGroup) GetOidcManagedGroupAttributes() (*OidcManagedGroupAttributes, error)

type ManagedGroupCreateResult 

type ManagedGroupCreateResult = ManagedGroupReadResult

type ManagedGroupDeleteResult 

type ManagedGroupDeleteResult struct {
	Response *api.Response
}

func (ManagedGroupDeleteResult) GetItem 

func (n ManagedGroupDeleteResult) GetItem() interface{}

GetItem will always be nil for ManagedGroupDeleteResult

func (ManagedGroupDeleteResult) GetResponse 

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

type ManagedGroupListResult 

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

func (n ManagedGroupListResult) GetEstItemCount() uint

func (ManagedGroupListResult) GetItems 

func (n ManagedGroupListResult) GetItems() []*ManagedGroup

func (ManagedGroupListResult) GetListToken added in v0.0.44 

func (n ManagedGroupListResult) GetListToken() string

func (ManagedGroupListResult) GetRemovedIds added in v0.0.44 

func (n ManagedGroupListResult) GetRemovedIds() []string

func (ManagedGroupListResult) GetResponse 

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

func (ManagedGroupListResult) GetResponseType added in v0.0.44 

func (n ManagedGroupListResult) GetResponseType() string

type ManagedGroupReadResult 

type ManagedGroupReadResult struct {
	Item     *ManagedGroup
	Response *api.Response
}

func (ManagedGroupReadResult) GetItem 

func (n ManagedGroupReadResult) GetItem() *ManagedGroup

func (ManagedGroupReadResult) GetResponse 

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

type ManagedGroupUpdateResult 

type ManagedGroupUpdateResult = ManagedGroupReadResult

type OidcManagedGroupAttributes 

type OidcManagedGroupAttributes struct {
	Filter string `json:"filter,omitempty"`
}

func AttributesMapToOidcManagedGroupAttributes added in v0.0.26 

func AttributesMapToOidcManagedGroupAttributes(in map[string]interface{}) (*OidcManagedGroupAttributes, 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 DefaultAttributes 

func DefaultAttributes() Option

func DefaultDescription 

func DefaultDescription() Option

func DefaultLdapManagedGroupGroupNames added in v0.0.35 

func DefaultLdapManagedGroupGroupNames() Option

func DefaultName 

func DefaultName() 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 WithLdapManagedGroupGroupNames added in v0.0.35 

func WithLdapManagedGroupGroupNames(inGroupNames []string) Option

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 WithOidcManagedGroupFilter 

func WithOidcManagedGroupFilter(inFilter string) Option

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.

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.