group

package
v0.103.2 Latest Latest
Warning

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

 Go to latest Published: May 20, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Enabled  State = "enabled"
	Disabled State = "disabled"

	AdminPermission = schema.DeletePermission

	MemberRole = schema.GroupMemberRole
	AdminRole  = schema.GroupOwnerRole
)

Variables

View Source 
var (
	ErrNotExist              = errors.New("group doesn't exist")
	ErrInvalidUUID           = errors.New("invalid syntax of uuid")
	ErrInvalidID             = errors.New("group id is invalid")
	ErrConflict              = errors.New("group already exist")
	ErrInvalidDetail         = errors.New("invalid group detail")
	ErrListingGroupRelations = errors.New("error while listing relations")
	ErrFetchingUsers         = errors.New("error while fetching users")
	ErrFetchingGroups        = errors.New("error while fetching groups")
)

Functions

This section is empty.

Types

type AuthnService 

type AuthnService interface {
	GetPrincipal(ctx context.Context, via ...authenticate.ClientAssertion) (authenticate.Principal, error)
}

type Filter 

type Filter struct {
	SU bool // super user

	OrganizationID  string
	State           State
	WithMemberCount bool

	GroupIDs []string
}

type Group 

type Group struct {
	ID             string
	Name           string
	Title          string
	OrganizationID string `json:"orgId"`
	Metadata       metadata.Metadata
	State          State
	CreatedAt      time.Time
	UpdatedAt      time.Time

	// Transient fields
	MemberCount int
}

type MembershipService added in v0.102.0 

type MembershipService interface {
	OnGroupCreated(ctx context.Context, groupID, orgID, creatorID, creatorType string) error
}

type PolicyService added in v0.7.5 

type PolicyService interface {
	List(ctx context.Context, flt policy.Filter) ([]policy.Policy, error)
	Delete(ctx context.Context, id string) error
	GroupMemberCount(ctx context.Context, ids []string) ([]policy.MemberCount, error)
}

type RelationService 

type RelationService interface {
	ListRelations(ctx context.Context, rel relation.Relation) ([]relation.Relation, error)
	LookupResources(ctx context.Context, rel relation.Relation) ([]string, error)
	Delete(ctx context.Context, rel relation.Relation) error
}

type Repository 

type Repository interface {
	Create(ctx context.Context, grp Group) (Group, error)
	GetByID(ctx context.Context, id string) (Group, error)
	GetByIDs(ctx context.Context, groupIDs []string, flt Filter) ([]Group, error)
	List(ctx context.Context, flt Filter) ([]Group, error)
	UpdateByID(ctx context.Context, toUpdate Group) (Group, error)
	SetState(ctx context.Context, id string, state State) error
	Delete(ctx context.Context, id string) error
}

type Service 

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

func NewService 

func NewService(repository Repository, relationService RelationService,
	authnService AuthnService, policyService PolicyService) *Service

func (Service) Create 

func (s Service) Create(ctx context.Context, grp Group) (Group, error)

func (Service) DeleteModel added in v0.103.0 

func (s Service) DeleteModel(ctx context.Context, id string) error

DeleteModel removes the group entity from storage and emits the audit event. All SpiceDB policy and relation cleanup is the caller's responsibility — see core/deleter.DeleteGroup for the orchestration that pairs this with membership.OnGroupDeleted.

func (Service) Disable 

func (s Service) Disable(ctx context.Context, id string) error

func (Service) Enable 

func (s Service) Enable(ctx context.Context, id string) error

func (Service) Get 

func (s Service) Get(ctx context.Context, id string) (Group, error)

func (Service) GetByIDs added in v0.7.6 

func (s Service) GetByIDs(ctx context.Context, ids []string) ([]Group, error)

func (Service) List 

func (s Service) List(ctx context.Context, flt Filter) ([]Group, error)

func (Service) ListByOrganization 

func (s Service) ListByOrganization(ctx context.Context, id string) ([]Group, error)

ListByOrganization will be useful for nested groups but we don't do that at the moment so it will not be directly used

func (Service) ListByUser 

func (s Service) ListByUser(ctx context.Context, principal authenticate.Principal, flt Filter) ([]Group, error)

func (Service) RemoveUsers 

func (s Service) RemoveUsers(ctx context.Context, groupID string, userIDs []string) error

RemoveUsers removes users from a group as members

func (*Service) SetMembershipService added in v0.102.0 

func (s *Service) SetMembershipService(ms MembershipService)

SetMembershipService sets the membership dependency after construction to break the circular init order between group and membership services.

func (Service) Update 

func (s Service) Update(ctx context.Context, grp Group) (Group, error)

type State 

type State string

func (State) String 

func (s State) String() string

Source Files

View all Source files

Directories

Path Synopsis

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.