Documentation
¶
Overview ¶
Package organization is responsible for OTF organizations
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewService ¶
func NewService(opts Options) *service
Types ¶
type Authorizer ¶
Authorizer authorizes access to an organization
type Client ¶
type Client struct {
internal.JSONAPIClient
}
type Entitlements ¶
type Entitlements struct {
ID string
Agents bool
AuditLogging bool
CostEstimation bool
Operations bool
PrivateModuleRegistry bool
SSO bool
Sentinel bool
StateStorage bool
Teams bool
VCSIntegrations bool
}
OTF is free and therefore the user is entitled to all currently supported services.
type Organization ¶
type Organization struct {
ID string `json:"id"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
Name string `json:"name"`
SessionRemember int `json:"session_remember"`
SessionTimeout int `json:"session_timeout"`
}
Organization is an OTF organization, comprising workspaces, users, etc.
func NewTestOrganization ¶
func NewTestOrganization(t *testing.T) *Organization
func (*Organization) String ¶
func (org *Organization) String() string
func (*Organization) Update ¶
func (org *Organization) Update(opts OrganizationUpdateOptions) error
type OrganizationList ¶
type OrganizationList struct {
*internal.Pagination
Items []*Organization
}
OrganizationList represents a list of Organizations.
type OrganizationListOptions ¶
type OrganizationListOptions struct {
internal.ListOptions
}
ListOptions represents the options for listing organizations.
type OrganizationPage ¶
OrganizationPage contains data shared by all organization-based pages.
type OrganizationService ¶
type OrganizationService = Service
type OrganizationUpdateOptions ¶
UpdateOptions represents the options for updating an organization.
type Service ¶
type Service interface {
UpdateOrganization(ctx context.Context, name string, opts OrganizationUpdateOptions) (*Organization, error)
GetOrganization(ctx context.Context, name string) (*Organization, error)
ListOrganizations(ctx context.Context, opts OrganizationListOptions) (*OrganizationList, error)
DeleteOrganization(ctx context.Context, name string) error
GetEntitlements(ctx context.Context, organization string) (Entitlements, error)
}
Click to show internal directories.
Click to hide internal directories.