viewer

Documentation

Overview

Package viewer contains role definitions for policies

Index

• Variables
• func NewContext(parent context.Context, v Viewer) context.Context
• type ContextKey
• type UserViewer
  • func NewUserViewerFromID(id string, hasID bool) *UserViewer
  • func NewUserViewerFromSubject(c context.Context) *UserViewer
  • func NewUserViewerFromUser(user *generated.User) *UserViewer
  • func (u UserViewer) GetGroupID() string
  • func (u UserViewer) GetID() (string, bool)
  • func (u UserViewer) GetOrganizationID() string
  • func (u UserViewer) IsAdmin() bool
• type Viewer
  • func FromContext(ctx context.Context) Viewer

Variables

var ViewerContextKey = &ContextKey{"ViewerContextKey"}

ViewerContextKey is the context key for the viewer-context

Functions

func NewContext

func NewContext(parent context.Context, v Viewer) context.Context

NewContext returns a copy of parent context with the given Viewer attached with it.

Types

type ContextKey

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

ContextKey is the key name for the additional context

type UserViewer

type UserViewer struct {
	GroupID string
	OrgID   string
	// contains filtered or unexported fields
}

UserViewer describes a user-viewer

func NewUserViewerFromID

func NewUserViewerFromID(id string, hasID bool) *UserViewer

NewUserViewerFromID gets the `id` and `hasID` fields of the `UserViewer` struct and is used to create a `UserViewer` when the user ID is known, but the actual user object is not available

func NewUserViewerFromSubject

func NewUserViewerFromSubject(c context.Context) *UserViewer

NewUserViewerFromSubject function creates a new `UserViewer` instance based on the user ID obtained from the context. It uses the `auth.GetUserIDFromContext` function to retrieve the user ID from the context

func NewUserViewerFromUser

func NewUserViewerFromUser(user *generated.User) *UserViewer

NewUserViewerFromUser function is used to create a new `UserViewer` instance based on a `generated.User` object - this function is useful when you have a user object and want to create a `UserViewer` from it

func (UserViewer) GetGroupID

func (u UserViewer) GetGroupID() string

GetGroupID returns the ID of the group

func (UserViewer) GetID

func (u UserViewer) GetID() (string, bool)

GetID returns the ID of the user and a boolean value indicating whether the ID exists or not

func (UserViewer) GetOrganizationID

func (u UserViewer) GetOrganizationID() string

GetOrganizationID returns the ID of the organization.

func (UserViewer) IsAdmin

func (u UserViewer) IsAdmin() bool

IsAdmin returns a boolean value indicating whether the user is an admin or not. In this implementation, the function always returns `false`, indicating that the user is not an admin

type Viewer

type Viewer interface {
	GetOrganizationID() string
	GetGroupID() string
	IsAdmin() bool
	GetID() (id string, exists bool)
}

Viewer describes the query/mutation viewer-context

func FromContext

func FromContext(ctx context.Context) Viewer

FromContext returns the Viewer stored in a context.