user

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 15, 2025 License: MPL-2.0 Imports: 26 Imported by: 0

Documentation

Overview

Package user manages user accounts and their team membership.

Index

Constants

This section is empty.

Variables

View Source 
var (
	SiteAdminUsername = Username{/* contains filtered or unexported fields */}
	// SiteAdminID is the hardcoded user id for the site admin user. The ID must
	// be the same as the hardcoded value in the database migrations.
	SiteAdminID = resource.MustHardcodeTfeID(resource.UserKind, "36atQC2oGQng7pVz")
	SiteAdmin   = User{ID: SiteAdminID, Username: SiteAdminUsername}
)
View Source 
var ErrCannotDeleteOnlyOwner = errors.New("cannot remove the last owner")

Functions

func NewTeamMembershipCommand 

func NewTeamMembershipCommand(apiclient *otfapi.Client) *cobra.Command

func NewUserCommand 

func NewUserCommand(apiClient *otfapi.Client) *cobra.Command

Types

type CreateUserOptions 

type CreateUserOptions struct {
	Username string `json:"username"`
}

type CreateUserTokenOptions 

type CreateUserTokenOptions struct {
	Description string
}

CreateUserTokenOptions are options for creating a user token via the service endpoint

type ListOptions added in v0.3.17 

type ListOptions struct {
	resource.PageOptions

	Organization organization.Name `schema:"name"`
}

ListOptions are options for the ListUsers endpoint.

type NewUserOption 

type NewUserOption func(*User)

func WithTeams 

func WithTeams(memberships ...*team.Team) NewUserOption

type Options 

type Options struct {
	SiteToken     string
	TokensService *tokens.Service
	TeamService   *team.Service
	Authorizer    *authz.Authorizer

	*sql.DB
	*tfeapi.Responder
	logr.Logger
}

type Service added in v0.2.2 

type Service struct {
	logr.Logger
	*authz.Authorizer
	// contains filtered or unexported fields
}

func NewService 

func NewService(opts Options) *Service

func (*Service) AddHandlers added in v0.2.2 

func (a *Service) AddHandlers(r *mux.Router)

func (*Service) AddTeamMembership added in v0.2.2 

func (a *Service) AddTeamMembership(ctx context.Context, teamID resource.TfeID, usernames []Username) error

AddTeamMembership adds users to a team. If a user does not exist then the user is created first.

func (*Service) Create added in v0.2.2 

func (a *Service) Create(ctx context.Context, username string, opts ...NewUserOption) (*User, error)

func (*Service) CreateToken added in v0.2.2 

func (a *Service) CreateToken(ctx context.Context, opts CreateUserTokenOptions) (*UserToken, []byte, error)

CreateToken creates a user token. Only users can create a user token, and they can only create a token for themselves.

func (*Service) Delete added in v0.2.2 

func (a *Service) Delete(ctx context.Context, username Username) error

func (*Service) DeleteToken added in v0.2.2 

func (a *Service) DeleteToken(ctx context.Context, tokenID resource.TfeID) error

func (*Service) GetUser added in v0.2.2 

func (a *Service) GetUser(ctx context.Context, spec UserSpec) (*User, error)

func (*Service) List added in v0.2.2 

func (a *Service) List(ctx context.Context) ([]*User, error)

List lists all users.

func (*Service) ListOrganizationUsers added in v0.2.2 

func (a *Service) ListOrganizationUsers(ctx context.Context, organization organization.Name) ([]*User, error)

ListOrganizationUsers lists an organization's users

func (*Service) ListTeamUsers added in v0.2.2 

func (a *Service) ListTeamUsers(ctx context.Context, teamID resource.TfeID) ([]*User, error)

ListTeamUsers lists users that are members of the given team. The caller needs either organization-wide authority to call this endpoint, or they need to be a member of the team.

func (*Service) ListTokens added in v0.2.2 

func (a *Service) ListTokens(ctx context.Context) ([]*UserToken, error)

func (Service) NewUserToken added in v0.2.2 

func (f Service) NewUserToken(username Username, opts CreateUserTokenOptions) (*UserToken, []byte, error)

func (*Service) RemoveTeamMembership added in v0.2.2 

func (a *Service) RemoveTeamMembership(ctx context.Context, teamID resource.TfeID, usernames []Username) error

RemoveTeamMembership removes users from a team.

func (*Service) SetSiteAdmins added in v0.2.2 

func (a *Service) SetSiteAdmins(ctx context.Context, usernames ...string) error

SetSiteAdmins authoritatively promotes users with the given usernames to site admins. If no such users exist then they are created. Any unspecified users that are currently site admins are demoted.

func (*Service) UpdateAvatar added in v0.3.25 

func (a *Service) UpdateAvatar(ctx context.Context, username Username, avatarURL string) error

type TFECreateUserOptions added in v0.3.17 

type TFECreateUserOptions struct {
	// Type is a public field utilized by JSON:API to
	// set the resource type via the field tag.
	// It is not a user-defined value and does not need to be set.
	// https://jsonapi.org/format/#crud-creating
	Type string `jsonapi:"primary,users"`

	Username *string `jsonapi:"attribute" json:"username"`
}

CreateUserOptions represents the options for creating a user.

type TFEOrganizationMembership added in v0.3.17 

type TFEOrganizationMembership struct {
	ID     resource.TfeID                  `jsonapi:"primary,organization-memberships"`
	Status TFEOrganizationMembershipStatus `jsonapi:"attribute" json:"status"`
	Email  string                          `jsonapi:"attribute" json:"email"`

	// Relations
	Organization *organization.TFEOrganization `jsonapi:"relationship" json:"organization"`
	User         *TFEUser                      `jsonapi:"relationship" json:"user"`
	Teams        []*team.TFETeam               `jsonapi:"relationship" json:"teams"`
}

TFEOrganizationMembership represents a Terraform Enterprise organization membership.

type TFEOrganizationMembershipCreateOptions added in v0.3.17 

type TFEOrganizationMembershipCreateOptions struct {
	// Type is a public field utilized by JSON:API to
	// set the resource type via the field tag.
	// It is not a user-defined value and does not need to be set.
	// https://jsonapi.org/format/#crud-creating
	Type string `jsonapi:"primary,organization-memberships"`

	// Required: User's email address.
	Email *string `jsonapi:"attribute" json:"email"`
}

TFEOrganizationMembershipCreateOptions represents the options for creating an organization membership.

type TFEOrganizationMembershipStatus added in v0.3.17 

type TFEOrganizationMembershipStatus string

TFEOrganizationMembershipStatus represents an organization membership status. 

const (
	OrganizationMembershipActive  TFEOrganizationMembershipStatus = "active"
	OrganizationMembershipInvited TFEOrganizationMembershipStatus = "invited"
)

type TFETwoFactor added in v0.3.17 

type TFETwoFactor struct {
	Enabled  bool `jsonapi:"attribute" json:"enabled"`
	Verified bool `jsonapi:"attribute" json:"verified"`
}

TFETwoFactor represents the organization permissions.

type TFEUser added in v0.3.17 

type TFEUser struct {
	ID               resource.TfeID `jsonapi:"primary,users"`
	AvatarURL        string         `jsonapi:"attribute" json:"avatar-url"`
	Email            string         `jsonapi:"attribute" json:"email"`
	IsServiceAccount bool           `jsonapi:"attribute" json:"is-service-account"`
	TwoFactor        *TFETwoFactor  `jsonapi:"attribute" json:"two-factor"`
	UnconfirmedEmail string         `jsonapi:"attribute" json:"unconfirmed-email"`
	Username         string         `jsonapi:"attribute" json:"username"`
	V2Only           bool           `jsonapi:"attribute" json:"v2-only"`
}

TFEUser represents an OTF user.

type User 

type User struct {
	ID        resource.TfeID `jsonapi:"primary,users" json:"user_id"`
	CreatedAt time.Time      `jsonapi:"attribute" json:"created-at"`
	UpdatedAt time.Time      `jsonapi:"attribute" json:"updated-at"`
	SiteAdmin bool           `jsonapi:"attribute" json:"site-admin"`
	// username is globally unique
	Username Username `jsonapi:"attribute" json:"username"`
	// user belongs to many teams
	Teams []*team.Team
	// AvatarURL is the URL of an avatar depicting user.
	AvatarURL *string
}

User represents an OTF user account.

func NewTestUser added in v0.3.18 

func NewTestUser(t *testing.T) *User

func NewUser 

func NewUser(usernameStr string, opts ...NewUserOption) (*User, error)

func UserFromContext 

func UserFromContext(ctx context.Context) (*User, error)

UserFromContext retrieves a user from a context

func (*User) CanAccess added in v0.3.6 

func (u *User) CanAccess(action authz.Action, req authz.Request) bool

func (*User) IsOwner 

func (u *User) IsOwner(organization resource.ID) bool

IsOwner determines if user is an owner of an organization

func (*User) IsSiteAdmin 

func (u *User) IsSiteAdmin() bool

IsSiteAdmin determines whether user is a site admin. A user is a site admin in either of two cases: (1) their account has been promoted to site admin (think sudo) (2) the account is *the* site admin (think root)

func (*User) IsTeamMember 

func (u *User) IsTeamMember(teamID resource.TfeID) bool

IsTeamMember determines whether user is a member of the given team.

func (*User) Organizations 

func (u *User) Organizations() []organization.Name

Organizations returns the user's membership of organizations (indirectly via their membership of teams).

NOTE: always returns a non-nil slice

func (*User) PictureURL added in v0.3.25 

func (u *User) PictureURL() *string

PictureURL avoids an import cycle with the UI components package, allowing the layout template to retrieve the current user's avatar URL.

func (*User) String 

func (u *User) String() string

type UserSpec 

type UserSpec struct {
	UserID                *resource.TfeID
	Username              *Username
	AuthenticationTokenID *resource.TfeID
}

func (UserSpec) LogValue 

func (s UserSpec) LogValue() slog.Value

type UserToken 

type UserToken struct {
	ID          resource.TfeID `db:"token_id"`
	CreatedAt   time.Time      `db:"created_at"`
	Description string
	Username    Username // Token belongs to a user
}

UserToken provides information about an API token for a user.

type Username added in v0.3.18 

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

Username of an OTF user.

func MustUsername added in v0.3.18 

func MustUsername(name string) Username

func NewTestUsername added in v0.3.18 

func NewTestUsername(t *testing.T) Username

func NewUsername added in v0.3.18 

func NewUsername(name string) (Username, error)

func (Username) Kind added in v0.3.18 

func (Username) Kind() resource.Kind

func (Username) MarshalText added in v0.3.18 

func (name Username) MarshalText() ([]byte, error)

func (*Username) Scan added in v0.3.18 

func (name *Username) Scan(text any) error

func (Username) String added in v0.3.18 

func (name Username) String() string

func (*Username) UnmarshalText added in v0.3.18 

func (name *Username) UnmarshalText(text []byte) error

func (*Username) Value added in v0.3.18 

func (name *Username) Value() (driver.Value, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.