organizations

Documentation

Index

• type Client
  • func New(client client.Client, namespace string) *Client
  • func (c *Client) Get(ctx context.Context, organizationID string) (*openapi.OrganizationRead, error)
  • func (c *Client) GetMetadata(ctx context.Context, organizationID string) (*Meta, error)
  • func (c *Client) List(ctx context.Context, rbacClient *rbac.RBAC) (openapi.Organizations, error)
  • func (c *Client) Update(ctx context.Context, organizationID string, request *openapi.OrganizationWrite) error
• type Meta

Types

type Client

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

func New

func New(client client.Client, namespace string) *Client

func (*Client) Get

func (c *Client) Get(ctx context.Context, organizationID string) (*openapi.OrganizationRead, error)

func (*Client) GetMetadata

func (c *Client) GetMetadata(ctx context.Context, organizationID string) (*Meta, error)

GetMetadata retrieves the organization metadata. Clients should consult at least the Active status before doing anything with the organization.

func (*Client) List

func (c *Client) List(ctx context.Context, rbacClient *rbac.RBAC) (openapi.Organizations, error)

func (*Client) Update

func (c *Client) Update(ctx context.Context, organizationID string, request *openapi.OrganizationWrite) error

type Meta

type Meta struct {
	// ID is the organization's Kubernetes name, so a higher level resource
	// can reference it.
	ID string

	// Namespace is the namespace that is provisioned by the organization.
	// Should be usable set when the organization is active.
	Namespace string
}

Meta describes the organization.