permission

Documentation

Index

• Constants
• func GetAccessibleGroups(permissions map[string]bool) map[string]bool
• func UserCanAccessDataset(userInfo pixlUser.UserInfo, summary datasetModel.SummaryFileData) error
• func UserCanAccessDatasetWithSummaryDownload(fs fileaccess.FileAccess, userInfo pixlUser.UserInfo, dataBucket string, ...) (datasetModel.SummaryFileData, error)

Constants

const PermBlessQuantification = "write:bless-quant"

Quantification blessing

const PermCreateQuantification = "write:quantification"

Quantification creation

const PermDownloadPiquant = "download:piquant"

const PermEditDiffractionPeaks = "write:diffraction-peaks"

const PermExportMap = "export:map"

Ability to export

const PermPublic = "public"

We have a few public things, mainly getting the API version...

const PermPublishQuantification = "write:publish-quant"

Quantification publishing

const PermReadDataAnalysis = "read:data-analysis"

For reading ROI, element set, annotation, expressions

const PermReadDiffractionPeaks = "read:diffraction-peaks"

const PermReadPIXLFullDataset = "read:pixl-full-dataset"

Permissions to view different kinds of datasets

const PermReadPIXLISESettings = "read:pixlise-settings"

General app permissions, eg saving/loading view state

const PermReadPIXLTacticalDataset = "read:pixl-tactical-dataset"

const PermReadPiquantConfig = "read:piquant-config"

Piquant setup/administration

const PermReadPiquantJobs = "read:piquant-jobs"

Piquant jobs

const PermReadTestFullDataset = "read:test-full-dataset"

const PermReadTestTacticalDataset = "read:test-tactical-dataset"

const PermReadUserRoles = "read:user-roles"

User administration

const PermReadUserSettings = "read:user-settings"

Users own settings/name/data collection agreement

const PermWriteDataAnalysis = "write:data-analysis"

For being able to write/delete/edit the above

const PermWriteDataset = "write:dataset"

For being able to edit custom fields/images on dataset

const PermWriteMetrics = "write:metrics"

For saving metrics

const PermWritePIXLISESettings = "write:pixlise-settings"

const PermWritePiquantConfig = "write:piquant-config"

const PermWriteSharedAnnotation = "write:shared-annotation"

const PermWriteSharedElementSet = "write:shared-element-set"

const PermWriteSharedExpression = "write:shared-expression"

const PermWriteSharedQuantification = "write:shared-quantification"

const PermWriteSharedROI = "write:shared-roi"

Sharing

const PermWriteUserRoles = "write:user-roles"

const PermWriteUserSettings = "write:user-settings"

Functions

func GetAccessibleGroups

func GetAccessibleGroups(permissions map[string]bool) map[string]bool

func UserCanAccessDataset

func UserCanAccessDataset(userInfo pixlUser.UserInfo, summary datasetModel.SummaryFileData) error

Returns nil if user CAN access it, otherwise a api.StatusError with the right HTTP error code

func UserCanAccessDatasetWithSummaryDownload

func UserCanAccessDatasetWithSummaryDownload(fs fileaccess.FileAccess, userInfo pixlUser.UserInfo, dataBucket string, datasetID string) (datasetModel.SummaryFileData, error)