Access control

Before any of the sample API endpoints can be used, the user needs to obtain an API key. See the general integration guide for details on how to obtain and use such a key.

There are four role groups related to Sample that may be assigned to an API key. Each with its own intended use case. It is recommended to use one of these instead of individually assigning permission functions.

SAMPLEDB-VIEWER

Read-only access to samples. The user is allowed to download samples, view metadata, analysis results, evidence attached to analysis, submissions, and links

SAMPLEDB-UPLOADER

Grants permission to add samples and submissions to the Sample service

SAMPLEDB-USER

Access to view and upload samples to the Sample service. The key will inherit all permissions granted by the SAMPLEDB-VIEWER and SAMPLEDB-UPLOADER roles. In addition, access is granted to request analysis jobs to be aborted.

SAMPLEDB-ANALYZER

Grants permission to add analysis results for samples. Only granted to superusers. The key will inherit all permissions granted by the SAMPLEDB-VIEWER and SAMPLEDB-USER roles. In addition, access is granted to add analysis results, evidence attached to analysis results, links, and verdicts