organization

Documentation

Overview

Package organization contains types and functions for managing organization data for the user.

Index

• type HTTPClient
• type Organization
  • func List(ctx context.Context, client HTTPClient) ([]Organization, error)

Types

type HTTPClient

type HTTPClient interface {
	Do(ctx context.Context, method, uri string, body, out interface{}) error
}

The HTTPClient interface describes types that perform HTTP requests.

type Organization

type Organization struct {
	ID    string   `json:"id"`
	Roles []string `json:"roles"`
}

The Organization type describes a single organization and the roles within it for the current user.

func List

func List(ctx context.Context, client HTTPClient) ([]Organization, error)

List all organizations the user has access to and their role within it. Organizations and their roles are sorted by name.