roles

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.

Index

• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) AddGrants(ctx context.Context, roleId string, version uint32, grantStrings []string, ...) (*RoleUpdateResult, error)
  • func (c *Client) AddPrincipals(ctx context.Context, roleId string, version uint32, principalIds []string, ...) (*RoleUpdateResult, error)
  • func (c *Client) ApiClient() *api.Client
  • func (c *Client) Create(ctx context.Context, scopeId string, opt ...Option) (*RoleCreateResult, error)
  • func (c *Client) Delete(ctx context.Context, roleId string, opt ...Option) (*RoleDeleteResult, error)
  • func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*RoleListResult, error)
  • func (c *Client) Read(ctx context.Context, roleId string, opt ...Option) (*RoleReadResult, error)
  • func (c *Client) RemoveGrants(ctx context.Context, roleId string, version uint32, grantStrings []string, ...) (*RoleUpdateResult, error)
  • func (c *Client) RemovePrincipals(ctx context.Context, roleId string, version uint32, principalIds []string, ...) (*RoleUpdateResult, error)
  • func (c *Client) SetGrants(ctx context.Context, roleId string, version uint32, grantStrings []string, ...) (*RoleUpdateResult, error)
  • func (c *Client) SetPrincipals(ctx context.Context, roleId string, version uint32, principalIds []string, ...) (*RoleUpdateResult, error)
  • func (c *Client) Update(ctx context.Context, roleId string, version uint32, opt ...Option) (*RoleUpdateResult, error)
• type Grant
• type GrantJson
• type Option
  • func DefaultDescription() Option
  • func DefaultGrantScopeId() Option
  • func DefaultName() Option
  • func WithAutomaticVersioning(enable bool) Option
  • func WithDescription(inDescription string) Option
  • func WithGrantScopeId(inGrantScopeId string) Option
  • func WithName(inName string) Option
• type Principal
• type Role
  • func (n Role) ResponseBody() *bytes.Buffer
  • func (n Role) ResponseMap() map[string]interface{}
• type RoleCreateResult
• type RoleDeleteResult
  • func (n RoleDeleteResult) GetResponseBody() *bytes.Buffer
  • func (n RoleDeleteResult) GetResponseMap() map[string]interface{}
• type RoleListResult
  • func (n RoleListResult) GetItems() interface{}
  • func (n RoleListResult) GetResponseBody() *bytes.Buffer
  • func (n RoleListResult) GetResponseMap() map[string]interface{}
• type RoleReadResult
  • func (n RoleReadResult) GetItem() interface{}
  • func (n RoleReadResult) GetResponseBody() *bytes.Buffer
  • func (n RoleReadResult) GetResponseMap() map[string]interface{}
• type RoleUpdateResult

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

func (c *Client) AddGrants(ctx context.Context, roleId string, version uint32, grantStrings []string, opt ...Option) (*RoleUpdateResult, error)

func (*Client) AddPrincipals

func (c *Client) AddPrincipals(ctx context.Context, roleId string, version uint32, principalIds []string, opt ...Option) (*RoleUpdateResult, error)

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, scopeId string, opt ...Option) (*RoleCreateResult, error)

func (*Client) Delete

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

func (*Client) List

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

func (*Client) Read

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

func (*Client) RemoveGrants

func (c *Client) RemoveGrants(ctx context.Context, roleId string, version uint32, grantStrings []string, opt ...Option) (*RoleUpdateResult, error)

func (*Client) RemovePrincipals

func (c *Client) RemovePrincipals(ctx context.Context, roleId string, version uint32, principalIds []string, opt ...Option) (*RoleUpdateResult, error)

func (*Client) SetGrants

func (c *Client) SetGrants(ctx context.Context, roleId string, version uint32, grantStrings []string, opt ...Option) (*RoleUpdateResult, error)

func (*Client) SetPrincipals

func (c *Client) SetPrincipals(ctx context.Context, roleId string, version uint32, principalIds []string, opt ...Option) (*RoleUpdateResult, error)

func (*Client) Update

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

type Grant

type Grant struct {
	Raw       string     `json:"raw,omitempty"`
	Canonical string     `json:"canonical,omitempty"`
	Json      *GrantJson `json:"json,omitempty"`
}

type GrantJson

type GrantJson struct {
	Id      string   `json:"id,omitempty"`
	Type    string   `json:"type,omitempty"`
	Actions []string `json:"actions,omitempty"`
}

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 DefaultDescription

func DefaultDescription() Option

func DefaultGrantScopeId

func DefaultGrantScopeId() Option

func DefaultName

func DefaultName() 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 WithGrantScopeId

func WithGrantScopeId(inGrantScopeId string) Option

func WithName

func WithName(inName string) Option

type Principal

type Principal struct {
	Id      string `json:"id,omitempty"`
	Type    string `json:"type,omitempty"`
	ScopeId string `json:"scope_id,omitempty"`
}

type Role

type Role 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"`
	GrantScopeId string            `json:"grant_scope_id,omitempty"`
	PrincipalIds []string          `json:"principal_ids,omitempty"`
	Principals   []*Principal      `json:"principals,omitempty"`
	GrantStrings []string          `json:"grant_strings,omitempty"`
	Grants       []*Grant          `json:"grants,omitempty"`
	// contains filtered or unexported fields
}

func (Role) ResponseBody

func (n Role) ResponseBody() *bytes.Buffer

func (Role) ResponseMap

func (n Role) ResponseMap() map[string]interface{}

type RoleCreateResult

type RoleCreateResult = RoleReadResult

type RoleDeleteResult

type RoleDeleteResult struct {
	// contains filtered or unexported fields
}

func (RoleDeleteResult) GetResponseBody

func (n RoleDeleteResult) GetResponseBody() *bytes.Buffer

func (RoleDeleteResult) GetResponseMap

func (n RoleDeleteResult) GetResponseMap() map[string]interface{}

type RoleListResult

type RoleListResult struct {
	Items []*Role
	// contains filtered or unexported fields
}

func (RoleListResult) GetItems

func (n RoleListResult) GetItems() interface{}

func (RoleListResult) GetResponseBody

func (n RoleListResult) GetResponseBody() *bytes.Buffer

func (RoleListResult) GetResponseMap

func (n RoleListResult) GetResponseMap() map[string]interface{}

type RoleReadResult

type RoleReadResult struct {
	Item *Role
	// contains filtered or unexported fields
}

func (RoleReadResult) GetItem

func (n RoleReadResult) GetItem() interface{}

func (RoleReadResult) GetResponseBody

func (n RoleReadResult) GetResponseBody() *bytes.Buffer

func (RoleReadResult) GetResponseMap

func (n RoleReadResult) GetResponseMap() map[string]interface{}

type RoleUpdateResult

type RoleUpdateResult = RoleReadResult