permission

const PermBlessQuantification = "write:bless-quant"

Quantification "blessing" - marking it as the correct one to use

const PermCreateQuantification = "write:quantification"

Quantification creation

const PermDownloadPiquant = "download:piquant"

Downloading PIQUANT builds - not fully finished, likely only serving linux binaries if our build system still creates them

const PermEditDiffractionPeaks = "write:diffraction-peaks"

Editing diffraction peaks (manually creating new ones, or marking detected ones as deleted)

const PermExportMap = "export:map"

Ability to export various data

const PermPublic = "public"

Public endpoints, mainly for getting the API version

const PermPublishQuantification = "write:publish-quant"

Quantification publishing - to PDS

const PermReadDataAnalysis = "read:data-analysis"

Reading ROI, element set, annotation, expressions, modules, tags, quantifications, RGB mixes

const PermReadDiffractionPeaks = "read:diffraction-peaks"

Reading diffraction peaks DB that's created along with a dataset

const PermReadLogs = "read:logs"

Reading logs and log level of API

const PermReadPIXLISESettings = "read:pixlise-settings"

Reading current view state, collections, workspaces

const PermReadPiquantConfig = "read:piquant-config"

Reading piquant detector config and piquant config files

const PermReadPiquantJobs = "read:piquant-jobs"

Reads all piquant jobs - admin level

const PermReadUserRoles = "read:user-roles"

User role access - reading user listing, role listing and user/role individual gets

const PermReadUserSettings = "read:user-settings"

Get users own config and data collection agreement

const PermTestEndpoints = "write:test-endpoints"

Ability to call test endpoints (admin feature)

const PermWriteDataAnalysis = "write:data-analysis"

Write/delete/edit ROI, element set, annotation, expressions, modules, tags, quantifications, RGB mixes

const PermWriteDataset = "write:dataset"

Allows editing custom fields/images on dataset, or creating new ones (using zipped MSA files, etc)

const PermWriteLogLevel = "write:log-level"

Changing API log level (admin feature really!)

const PermWriteMetrics = "write:metrics"

For saving metrics - aka user tracking info, UI behaviours, for research purposes

const PermWritePIXLISESettings = "write:pixlise-settings"

Writing current view state, collections, workspaces

const PermWritePiquantConfig = "write:piquant-config"

Writing piquant config (for spectroscopists who know what they're doing with piquant)

const PermWriteSharedAnnotation = "write:shared-annotation"

Sharing annotations (of spectrum chart)

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

Sharing element sets

const PermWriteSharedExpression = "write:shared-expression"

Sharing expressions

const PermWriteSharedQuantification = "write:shared-quantification"

Sharing quantifications

const PermWriteSharedROI = "write:shared-roi"

Sharing ROI

const PermWriteUserRoles = "write:user-roles"

Writing/deleting user roles, and editing users in bulk

const PermWriteUserSettings = "write:user-settings"

Writing users own config and data collection agreement