policy

Documentation

Index

• Variables
• type Filter
• type Filters
• type MemberCount
• type Policy
• type RelationService
• type Repository
• type RoleService
• type Service
  • func NewService(repository Repository, relationService RelationService, ...) *Service
  • func (s Service) AssignRole(ctx context.Context, pol Policy) error
  • func (s Service) Create(ctx context.Context, policy Policy) (Policy, error)
  • func (s Service) Delete(ctx context.Context, id string) error
  • func (s Service) Get(ctx context.Context, id string) (Policy, error)
  • func (s Service) GroupMemberCount(ctx context.Context, ids []string) ([]MemberCount, error)
  • func (s Service) List(ctx context.Context, f Filter) ([]Policy, error)
  • func (s Service) ListRoles(ctx context.Context, ...) ([]role.Role, error)
  • func (s Service) ProjectMemberCount(ctx context.Context, ids []string) ([]MemberCount, error)

Variables

var (
	ErrNotExist      = errors.New("policies doesn't exist")
	ErrInvalidUUID   = errors.New("invalid syntax of uuid")
	ErrInvalidID     = errors.New("policy id is invalid")
	ErrConflict      = errors.New("policy already exist")
	ErrInvalidDetail = errors.New("invalid policy detail")
)

Types

type Filter

type Filter struct {
	OrgID     string
	ProjectID string
	GroupID   string
	RoleID    string

	PrincipalType string
	PrincipalID   string
	PrincipalIDs  []string
	ResourceType  string
}

type Filters

type Filters struct {
	UserID  string
	GroupID string
}

type MemberCount

type MemberCount struct {
	ID    string `db:"id"`
	Count int    `db:"count"`
}

type Policy

type Policy struct {
	ID            string
	RoleID        string
	ResourceID    string `json:"resource_id"`
	ResourceType  string `json:"resource_type"`
	PrincipalID   string `json:"principal_id"`
	PrincipalType string `json:"principal_type"`
	Metadata      metadata.Metadata

	CreatedAt time.Time
	UpdatedAt time.Time
}

type RelationService

type RelationService interface {
	Create(ctx context.Context, rel relation.Relation) (relation.Relation, error)
	Delete(ctx context.Context, rel relation.Relation) error
}

type Repository

type Repository interface {
	Get(ctx context.Context, id string) (Policy, error)
	List(ctx context.Context, f Filter) ([]Policy, error)
	Upsert(ctx context.Context, pol Policy) (Policy, error)
	Delete(ctx context.Context, id string) error
	GroupMemberCount(ctx context.Context, IDs []string) ([]MemberCount, error)
	ProjectMemberCount(ctx context.Context, IDs []string) ([]MemberCount, error)
}

type RoleService

type RoleService interface {
	Get(ctx context.Context, id string) (role.Role, error)
	List(ctx context.Context, f role.Filter) ([]role.Role, error)
}

type Service

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

func NewService

func NewService(repository Repository, relationService RelationService, roleService RoleService) *Service

func (Service) AssignRole

func (s Service) AssignRole(ctx context.Context, pol Policy) error

AssignRole Note: ideally this should be in a single transaction read more about how user defined roles work in spicedb https://authzed.com/blog/user-defined-roles

func (Service) Create

func (s Service) Create(ctx context.Context, policy Policy) (Policy, error)

func (Service) Delete

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

func (Service) Get

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

func (Service) GroupMemberCount

func (s Service) GroupMemberCount(ctx context.Context, ids []string) ([]MemberCount, error)

func (Service) List

func (s Service) List(ctx context.Context, f Filter) ([]Policy, error)

func (Service) ListRoles

func (s Service) ListRoles(ctx context.Context, principalType, principalID, objectNamespace, objectID string) ([]role.Role, error)

ListRoles lists roles assigned via policies to a user

func (Service) ProjectMemberCount

func (s Service) ProjectMemberCount(ctx context.Context, ids []string) ([]MemberCount, error)