team

Documentation

Overview

Package team manages teams, which are groups of users with shared privileges.

Index

• Constants
• Variables
• func NewService(opts Options) *service
• func NewTeamCommand(client *otfapi.Client) *cobra.Command
• type Client
  • func (c *Client) CreateTeam(ctx context.Context, organization string, opts CreateTeamOptions) (*Team, error)
  • func (c *Client) DeleteTeam(ctx context.Context, id string) error
  • func (c *Client) GetTeam(ctx context.Context, organization, name string) (*Team, error)
• type CreateTeamOptions
• type CreateTokenOptions
• type Options
• type OrganizationAccess
• type OrganizationAccessOptions
• type Team
  • func (t *Team) CanAccessOrganization(action rbac.Action, org string) bool
  • func (t *Team) CanAccessSite(action rbac.Action) bool
  • func (t *Team) CanAccessTeam(action rbac.Action, id string) bool
  • func (t *Team) CanAccessWorkspace(action rbac.Action, policy internal.WorkspacePolicy) bool
  • func (t *Team) IsOwner(organization string) bool
  • func (t *Team) IsOwners() bool
  • func (t *Team) IsSiteAdmin() bool
  • func (t *Team) OrganizationAccess() OrganizationAccess
  • func (t *Team) Organizations() []string
  • func (t *Team) String() string
  • func (t *Team) Update(opts UpdateTeamOptions) error
• type TeamRow
  • func (row TeamRow) ToTeam() *Team
• type TeamService
• type Token
  • func (t *Token) LogValue() slog.Value
• type UpdateTeamOptions

Constants

const TeamTokenKind tokens.Kind = "team_token"

Variables

var ErrRemovingOwnersTeamNotPermitted = errors.New("the owners team cannot be deleted")

Functions

func NewService

func NewService(opts Options) *service

func NewTeamCommand

func NewTeamCommand(client *otfapi.Client) *cobra.Command

Types

type Client

type Client struct {
	*otfapi.Client

	// Client does not implement all of TeamService
	TeamService
}

func (*Client) CreateTeam

func (c *Client) CreateTeam(ctx context.Context, organization string, opts CreateTeamOptions) (*Team, error)

CreateTeam creates a team via HTTP/JSONAPI.

func (*Client) DeleteTeam

func (c *Client) DeleteTeam(ctx context.Context, id string) error

DeleteTeam deletes a team via HTTP/JSONAPI.

func (*Client) GetTeam

func (c *Client) GetTeam(ctx context.Context, organization, name string) (*Team, error)

GetTeam retrieves a team via HTTP/JSONAPI.

type CreateTeamOptions

type CreateTeamOptions struct {
	// Name of team to create
	Name *string `json:"name" schema:"name,required"`

	OrganizationAccessOptions

	// TFE fields that OTF does not support but persists merely to pass the
	// go-tfe integration tests
	SSOTeamID  *string
	Visibility *string
}

type CreateTokenOptions

type CreateTokenOptions struct {
	TeamID string
	Expiry *time.Time
}

CreateTokenOptions are options for creating an team token via the service endpoint

type Options

type Options struct {
	*sql.DB
	*tfeapi.Responder
	html.Renderer
	internal.HostnameService
	organization.OrganizationService
	tokens.TokensService
	logr.Logger
}

type OrganizationAccess

type OrganizationAccess struct {
	ManageWorkspaces bool // admin access on all workspaces
	ManageVCS        bool // manage VCS providers
	ManageModules    bool // manage module registry

	// TFE fields that OTF does not support but persists merely to pass the
	// go-tfe integration tests
	ManageProviders       bool
	ManagePolicies        bool
	ManagePolicyOverrides bool
}

OrganizationAccess defines a team's organization access.

type OrganizationAccessOptions

type OrganizationAccessOptions struct {
	ManageWorkspaces *bool `schema:"manage_workspaces"`
	ManageVCS        *bool `schema:"manage_vcs"`
	ManageModules    *bool `schema:"manage_modules"`

	// TFE fields that OTF does not support but persists merely to pass the
	// go-tfe integration tests
	ManageProviders       *bool
	ManagePolicies        *bool
	ManagePolicyOverrides *bool
}

OrganizationAccessOptions defines access to be granted upon team creation or to grant/rescind to/from an existing team.

type Team

type Team struct {
	ID           string    `jsonapi:"primary,teams"`
	CreatedAt    time.Time `jsonapi:"attribute" json:"created-at"`
	Name         string    `jsonapi:"attribute" json:"name"`
	Organization string    `jsonapi:"attribute" json:"organization"`

	Access OrganizationAccess

	// TFE fields that OTF does not support but persists merely to pass the
	// go-tfe integration tests
	Visibility string
	SSOTeamID  *string
}

Team is a group of users sharing a level of authorization.

func (*Team) CanAccessOrganization

func (t *Team) CanAccessOrganization(action rbac.Action, org string) bool

func (*Team) CanAccessSite

func (t *Team) CanAccessSite(action rbac.Action) bool

func (*Team) CanAccessTeam

func (t *Team) CanAccessTeam(action rbac.Action, id string) bool

func (*Team) CanAccessWorkspace

func (t *Team) CanAccessWorkspace(action rbac.Action, policy internal.WorkspacePolicy) bool

func (*Team) IsOwner

func (t *Team) IsOwner(organization string) bool

func (*Team) IsOwners

func (t *Team) IsOwners() bool

func (*Team) IsSiteAdmin

func (t *Team) IsSiteAdmin() bool

func (*Team) OrganizationAccess

func (t *Team) OrganizationAccess() OrganizationAccess

func (*Team) Organizations

func (t *Team) Organizations() []string

func (*Team) String

func (t *Team) String() string

func (*Team) Update

func (t *Team) Update(opts UpdateTeamOptions) error

type TeamRow

type TeamRow struct {
	TeamID                          pgtype.Text        `json:"team_id"`
	Name                            pgtype.Text        `json:"name"`
	CreatedAt                       pgtype.Timestamptz `json:"created_at"`
	PermissionManageWorkspaces      pgtype.Bool        `json:"permission_manage_workspaces"`
	PermissionManageVCS             pgtype.Bool        `json:"permission_manage_vcs"`
	PermissionManageModules         pgtype.Bool        `json:"permission_manage_modules"`
	OrganizationName                pgtype.Text        `json:"organization_name"`
	SSOTeamID                       pgtype.Text        `json:"sso_team_id"`
	Visibility                      pgtype.Text        `json:"visibility"`
	PermissionManagePolicies        pgtype.Bool        `json:"permission_manage_policies"`
	PermissionManagePolicyOverrides pgtype.Bool        `json:"permission_manage_policy_overrides"`
	PermissionManageProviders       pgtype.Bool        `json:"permission_manage_providers"`
}

TeamRow represents the result of a database query for a team.

func (TeamRow) ToTeam

func (row TeamRow) ToTeam() *Team

type TeamService

type TeamService interface {
	CreateTeam(ctx context.Context, organization string, opts CreateTeamOptions) (*Team, error)
	GetTeam(ctx context.Context, organization, team string) (*Team, error)
	GetTeamByID(ctx context.Context, teamID string) (*Team, error)
	GetTeamByTokenID(ctx context.Context, teamTokenID string) (*Team, error)
	ListTeams(ctx context.Context, organization string) ([]*Team, error)
	UpdateTeam(ctx context.Context, teamID string, opts UpdateTeamOptions) (*Team, error)
	DeleteTeam(ctx context.Context, teamID string) error

	AfterCreateTeam(hook func(context.Context, *Team) error)
	// contains filtered or unexported methods
}

type Token

type Token struct {
	ID        string
	CreatedAt time.Time

	// Token belongs to a team
	TeamID string
	// Optional expiry.
	Expiry *time.Time
}

Token provides information about an API token for a team.

func (*Token) LogValue

func (t *Token) LogValue() slog.Value

type UpdateTeamOptions

type UpdateTeamOptions struct {
	Name *string

	OrganizationAccessOptions

	// TFE fields that OTF does not support but persists merely to pass the
	// go-tfe integration tests
	SSOTeamID  *string
	Visibility *string
}