# Built-in permission sets and available permissions

Tonic Textual comes with a set of built-in global, dataset, and guided redaction permission sets. You cannot edit or delete the built-in permission sets.

Each permission is assigned Textual permissions. When a new permission is added to Textual, it is also added to the appropriate built-in permission sets.

## **Built-in global permission sets**

Textual comes with the following built-in global permission sets:

* **Admin -** Provides complete access to all global permissions. The Admin permission set automatically receives any new global permissions.
* **Admin (Environment) -** For self-hosted only. Identical to the Admin permission set. Only assigned to users and groups listed in the value of the [environment variable](https://docs.tonic.ai/textual/textual-install-administer/configuring-textual/textual-env-var-configure) `TEXTUAL_ADMINISTRATORS`.
* **General User -** Allows users to create datasets and custom entity types. Users can also use the **Home** page and the **Request Explorer**. By default, the **General User** permission set is assigned to all Textual users and SSO groups.

## **Available global permissions**

The following tables list the available global permissions, and indicate how the permissions apply to the built-in global permission sets.

### **Textual API and requests**

<table><thead><tr><th valign="top">Permission</th><th valign="top">General User</th><th valign="top">Admin and Admin (Environment)</th></tr></thead><tbody><tr><td valign="top">Create an API key</td><td valign="top">✔️</td><td valign="top">✔️</td></tr><tr><td valign="top">Use the playground on the Home page</td><td valign="top">✔️</td><td valign="top">✔️</td></tr><tr><td valign="top">Use the API to parse or redact a text string</td><td valign="top">✔️</td><td valign="top">✔️</td></tr><tr><td valign="top">Use the Request Explorer</td><td valign="top">✔️</td><td valign="top">✔️</td></tr></tbody></table>

### **Configuration management**

<table><thead><tr><th valign="top">Permission</th><th width="147.39996337890625" valign="top">General User</th><th valign="top">Admin and Admin (Environment)</th></tr></thead><tbody><tr><td valign="top">Create custom entity types</td><td valign="top">✔️</td><td valign="top">✔️</td></tr><tr><td valign="top">Edit any custom entity type</td><td valign="top"><br></td><td valign="top">✔️</td></tr></tbody></table>

### **Datasets**

<table><thead><tr><th valign="top">Permission</th><th valign="top">General User</th><th valign="top">Admin and Admin (Environment)</th></tr></thead><tbody><tr><td valign="top">Create datasets</td><td valign="top">✔️</td><td valign="top">✔️</td></tr><tr><td valign="top">Manage access to datasets</td><td valign="top"></td><td valign="top">✔️</td></tr><tr><td valign="top">View all datasets</td><td valign="top"><br></td><td valign="top">✔️</td></tr></tbody></table>

### Guided redaction

<table><thead><tr><th width="181.99993896484375" valign="top">Permission</th><th width="145" valign="top">General User</th><th valign="top">Admin and Admin (Environment)</th></tr></thead><tbody><tr><td valign="top">Use guided redaction projects</td><td valign="top">✔</td><td valign="top">✔</td></tr><tr><td valign="top">Create guided redaction projects</td><td valign="top">✔</td><td valign="top">✔</td></tr><tr><td valign="top">Control access to all guided redaction projects</td><td valign="top"></td><td valign="top">✔</td></tr><tr><td valign="top">View all guided redaction projects</td><td valign="top"></td><td valign="top">✔</td></tr><tr><td valign="top">Create redaction reference codes</td><td valign="top"></td><td valign="top">✔</td></tr><tr><td valign="top">Edit redaction reference codes</td><td valign="top"></td><td valign="top">✔</td></tr><tr><td valign="top">Create guided redaction status values</td><td valign="top"></td><td valign="top">✔</td></tr><tr><td valign="top">Edit guided redaction status values</td><td valign="top"><br></td><td valign="top">✔</td></tr></tbody></table>

### **Users and permissions**

<table><thead><tr><th width="201.20001220703125" valign="top">Permission</th><th width="143.39996337890625" valign="top">General User</th><th valign="top">Admin and Admin (Environment)</th></tr></thead><tbody><tr><td valign="top">Manage custom permission sets</td><td valign="top"></td><td valign="top">✔️</td></tr><tr><td valign="top">Manage access to global permission sets</td><td valign="top"></td><td valign="top">✔️</td></tr><tr><td valign="top">View users and groups</td><td valign="top">✔️</td><td valign="top">✔️</td></tr><tr><td valign="top">Manage users and user groups</td><td valign="top"></td><td valign="top">✔️</td></tr><tr><td valign="top">View usage metrics</td><td valign="top"></td><td valign="top">✔️</td></tr></tbody></table>

## **Built-in dataset permission sets**

Textual comes with the following built-in permission sets:

* **Editor -** A dataset Editor has full access to view, edit, and share access to a dataset.\
  \
  When you create a dataset, you are automatically granted the Editor permission set for that dataset.
* **Viewer -** A dataset Viewer only has access to view the configuration and to preview and download the results.

## **Available dataset permissions**

The following tables list the available dataset permissions, and indicate how the permissions apply to the built-in dataset permission sets.

### **General dataset management**

<table><thead><tr><th valign="top">Permission</th><th valign="top">Viewer</th><th valign="top">Editor</th></tr></thead><tbody><tr><td valign="top">View dataset settings</td><td valign="top">✔️</td><td valign="top">✔️</td></tr><tr><td valign="top">Edit dataset settings</td><td valign="top"></td><td valign="top">✔️</td></tr><tr><td valign="top">Share dataset access</td><td valign="top"></td><td valign="top">✔️</td></tr><tr><td valign="top">Delete a dataset</td><td valign="top"></td><td valign="top">✔️</td></tr></tbody></table>

### **Dataset file management**

<table><thead><tr><th valign="top">Permission</th><th valign="top">Viewer</th><th valign="top">Editor</th></tr></thead><tbody><tr><td valign="top">Upload files to a dataset</td><td valign="top"><br></td><td valign="top">✔️</td></tr><tr><td valign="top">Start a scan of dataset files</td><td valign="top">✔️</td><td valign="top">✔️</td></tr><tr><td valign="top">Delete files from a dataset</td><td valign="top"><br></td><td valign="top">✔️</td></tr><tr><td valign="top">Preview redacted dataset files</td><td valign="top">✔️</td><td valign="top">✔️</td></tr><tr><td valign="top">Download redacted dataset files</td><td valign="top">✔️</td><td valign="top">✔️</td></tr></tbody></table>

## Built-in guided redaction permission sets

Textual comes with the following built-in guided redaction permission sets:

* **Editor -** An Editor has almost full access to a guided redaction project.\
  \
  The one permission an Editor does not have is the permission to review redactions.\
  \
  When you create a project, you are assigned the Editor permission set.
* **Viewer -** A Viewer can view project settings, change statuses, and review redactions.

## Available guided redaction permissions

The following tables list the available guided redaction permissions, and indicate how the permissions apply to the built-in guided redaction permission sets.

### **General project management**

<table><thead><tr><th valign="top">Permission</th><th valign="top">Editor</th><th valign="top">Viewer</th></tr></thead><tbody><tr><td valign="top">View project settings</td><td valign="top">✔</td><td valign="top">✔</td></tr><tr><td valign="top">Edit project settings</td><td valign="top">✔</td><td valign="top"></td></tr><tr><td valign="top">Share project access</td><td valign="top">✔</td><td valign="top"></td></tr><tr><td valign="top">Delete a project</td><td valign="top">✔</td><td valign="top"></td></tr></tbody></table>

### **Project file management**

<table><thead><tr><th valign="top">Permission</th><th valign="top">Editor</th><th valign="top">Viewer</th></tr></thead><tbody><tr><td valign="top">Upload files to a project</td><td valign="top">✔</td><td valign="top"></td></tr><tr><td valign="top">Download project files</td><td valign="top">✔</td><td valign="top">✔</td></tr><tr><td valign="top">Delete files from a project</td><td valign="top">✔</td><td valign="top"></td></tr><tr><td valign="top">Edit file redactions</td><td valign="top">✔</td><td valign="top"></td></tr><tr><td valign="top">Preview project files</td><td valign="top">✔</td><td valign="top">✔</td></tr></tbody></table>

### **Review and collaboration**

<table><thead><tr><th valign="top">Permission</th><th valign="top">Editor</th><th valign="top">Viewer</th></tr></thead><tbody><tr><td valign="top">Manage comments</td><td valign="top">✔</td><td valign="top"></td></tr><tr><td valign="top">Review redactions</td><td valign="top">✔</td><td valign="top"></td></tr><tr><td valign="top">View audit log</td><td valign="top">✔</td><td valign="top">✔</td></tr></tbody></table>