Built-in permission sets and available permissions

Tonic Textual comes with a set of built-in global, pipeline, and dataset 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 TEXTUAL_ADMINISTRATORS.

• General User - Allows users to create datasets, pipelines, 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

Permission	General User	Admin and Admin (Environment)
Create an API key	✔️	✔️
Use the playground on the Home page	✔️	✔️
Use the API to parse or redact a text string	✔️	✔️
Use the Request Explorer	✔️	✔️

Configuration management

Permission	General User	Admin and Admin (Environment)
Create custom entity types	✔️	✔️
Edit any custom entity type		✔️

Datasets and pipelines

Permission	General User	Admin and Admin (Environment)
Create datasets	✔️	✔️
Manage access to datasets		✔️
Create pipelines	✔️	✔️
Manage access to pipelines		✔️
View all datasets		✔️
View all pipelines		✔️

Users and permissions

Permission	General User	Admin and Admin (Environment)
Manage custom permission sets		✔️
Manage access to global permission sets		✔️
View users and groups	✔️	✔️
Manage users and user groups		✔️
View usage metrics		✔️

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 global permission sets.

General dataset management

Permission	Viewer	Editor
View dataset settings	✔️	✔️
Edit dataset settings		✔️
Share dataset access		✔️
Delete a dataset		✔️

Dataset file management

Permission	Viewer	Editor
Upload files to a dataset		✔️
Start a scan of dataset files	✔️	✔️
Delete files from a dataset		✔️
Preview redacted dataset files	✔️	✔️
Download redacted dataset files	✔️	✔️

Built-in pipeline permission sets

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

• Editor - A pipeline Editor has full access to view, edit, and share access to a pipeline. When you create a pipeline, you are automatically granted the Editor permission set for that pipeline.

• Viewer - A pipeline Viewer only has access to view the configuration and download results.

Available pipeline permissions

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

General pipeline management

Permission	Viewer	Editor
View pipeline settings	✔️	✔️
Edit pipeline settings		✔️
Share pipeline access		✔️
Delete a pipeline		✔️

Pipeline file management

Permission	Viewer	Editor
Manage the pipeline file list		✔️
Preview pipeline files	✔️	✔️
Start pipeline runs	✔️	✔️