permissions

Documentation

Overview

Package permissions defined models and service interfaces for all permission- related functionality. @TODO: Examples

Index

• func RegisterApolloPermissions(service Service) error
• type Permission
  • func (p Permission) String() string
• type PermissionGroup
  • func (pg *PermissionGroup) Clone() *PermissionGroup
  • func (pg *PermissionGroup) Get(permission Permission) bool
• type PermissionGroupID
• type Service

Functions

func RegisterApolloPermissions

func RegisterApolloPermissions(service Service) error

Types

type Permission

type Permission string

const (
	// Users
	PermViewAllUsers Permission = "view_all_users"
	PermEditAllUsers Permission = "edit_all_users"
	PermViewOwnUser  Permission = "view_own_user"
	PermEditOwnUser  Permission = "edit_own_user"

	// Organisations
	PermViewAllOrganisations Permission = "view_all_organisations"
	PermEditAllOrganisations Permission = "edit_all_organisations"
	PermViewOwnOrganisation  Permission = "view_own_organisation"
	PermEditOwnOrganisation  Permission = "edit_own_organisation"

	// Permission groups
	PermViewAllPermissionGroups        Permission = "view_all_permissiongroups"
	PermEditAllPermissionGroups        Permission = "edit_all_permissiongroups"
	PermViewOwnPermissionGroups        Permission = "view_own_permissiongroups"
	PermEditOwnPermissionGroups        Permission = "edit_own_permissiongroups"
	PermEditPermissionGroupPermissions Permission = "edit_permissiongroup_permissions"
)

func (Permission) String

func (p Permission) String() string

type PermissionGroup

type PermissionGroup struct {
	ID          PermissionGroupID
	Name        string
	Permissions map[Permission]bool
}

func (*PermissionGroup) Clone

func (pg *PermissionGroup) Clone() *PermissionGroup

func (*PermissionGroup) Get

func (pg *PermissionGroup) Get(permission Permission) bool

type PermissionGroupID

type PermissionGroupID = core.ID

type Service

type Service interface {
	// Store a new permission, if it doesn't already exist
	RegisterPermission(ctx context.Context, permission Permission) error
	// Lists all permissions that have been registered before
	ListPermissions(ctx context.Context) ([]Permission, error)
	// Return a permission group by its ID.
	// If the group does not exist, this returns core.ErrNotFound
	GetPermissionGroup(ctx context.Context, id PermissionGroupID) (*PermissionGroup, error)
	// Update a permission group
	UpdatePermissionGroup(ctx context.Context, group *PermissionGroup) error
	// Delete a permission group
	DeletePermissionGroup(ctx context.Context, id PermissionGroupID) error
	// Create a new permission group. If no ID was provided, the returned permissiongroup will contain the generated id
	// If an ID was provided as input, the permission group will have that ID. If another group with the same
	// id already exists, this will return core.ErrConflict.
	CreatePermissionGroup(ctx context.Context, group *PermissionGroup) (*PermissionGroup, error)
	// Rename the specified permission group
	RenamePermissionGroup(ctx context.Context, id PermissionGroupID, name string) error
	// Returns whether or not the specified user has the specified permission in any of its permission groups.
	HasAny(ctx context.Context, userID core.UserID, permission Permission) (bool, error)
	// Returns whether or not the specified user has the specified permission in any of its permission groups for the
	// specified organisation.
	HasAnyForOrg(
		ctx context.Context,
		userID core.UserID,
		orgID core.OrganisationID,
		permission Permission,
	) (bool, error)
	// Returns whether or not the specified user has the specified permission in any of its permission groups for the
	// specified organisation, or any of its parent organisations.
	HasAnyForOrgTree(
		ctx context.Context,
		userID core.UserID,
		orgID core.OrganisationID,
		permission Permission,
	) (bool, error)
	// Lists all permission groups in the system
	ListPermissionGroups(ctx context.Context) ([]PermissionGroup, error)
	// Lists all permission groups for the specified user
	ListPermissionGroupsForUser(ctx context.Context, userID core.UserID) ([]PermissionGroup, error)
	// Add an existing user to an existing permission group
	AddUserToPermissionGroup(
		ctx context.Context,
		userID core.UserID,
		groupID PermissionGroupID,
	) error
	// Return the combined permissions for the specified user.
	// If a user has multiple permission groups, the combined permission group will contain all permissions that are
	// enabled in at least one of their permission groups.
	GetUserPermissions(
		ctx context.Context,
		userID core.UserID,
	) (map[Permission]bool, error)
	// Lists all permission groups for the specified user in the specified organisation
	ListPermissionGroupsForUserForOrganisation(
		ctx context.Context,
		userID core.UserID,
		orgID core.OrganisationID,
	) ([]PermissionGroup, error)
	// Add an existing user to an existing permission group in the specified organisation
	AddUserToPermissionGroupForOrganisation(
		ctx context.Context,
		userID core.UserID,
		orgID core.OrganisationID,
		groupID PermissionGroupID,
	) error
	// Return the combined permissions for the specified user in the specified organisation.
	// If a user has multiple permission groups, the combined permission group will contain all permissions that are
	// enabled in at least one of their permission groups.
	GetUserPermissionsForOrganisation(
		ctx context.Context,
		userID core.UserID,
		orgID core.OrganisationID,
	) (map[Permission]bool, error)
}