LogoLogo
Release notesPython SDK docsDocs homeTextual CloudTonic.ai
  • Tonic Textual guide
  • Getting started with Textual
  • Previewing Textual detection and redaction
  • Entity types that Textual detects
    • Built-in entity types
    • Managing custom entity types
  • Language support in Textual
  • Datasets - Create redacted files
    • Datasets workflow for text redaction
    • Creating and managing datasets
    • Assigning tags to datasets
    • Adding and removing dataset files
    • Reviewing the sensitivity detection results
    • Configuring the redaction
      • Configuring added and excluded values for built-in entity types
      • Working with custom entity types
      • Selecting the handling option for entity types
      • Configuring synthesis options
      • Configuring handling of file components
    • Adding manual overrides to PDF files
      • Editing an individual PDF file
      • Creating templates to apply to PDF files
    • Sharing dataset access
    • Previewing the original and redacted data in a file
    • Downloading redacted data
  • Pipelines - Prepare LLM content
    • Pipelines workflow for LLM preparation
    • Viewing pipeline lists and details
    • Assigning tags to pipelines
    • Setting up pipelines
      • Creating and editing pipelines
      • Supported file types for pipelines
      • Creating custom entity types from a pipeline
      • Configuring file synthesis for a pipeline
      • Configuring an Amazon S3 pipeline
      • Configuring a Databricks pipeline
      • Configuring an Azure pipeline
      • Configuring a Sharepoint pipeline
      • Selecting files for an uploaded file pipeline
    • Starting a pipeline run
    • Sharing pipeline access
    • Viewing pipeline results
      • Viewing pipeline files, runs, and statistics
      • Displaying details for a processed file
      • Structure of the pipeline output file JSON
    • Downloading and using pipeline output
  • Textual Python SDK
    • Installing the Textual SDK
    • Creating and revoking Textual API keys
    • Obtaining JWT tokens for authentication
    • Instantiating the SDK client
    • Datasets and redaction
      • Create and manage datasets
      • Redact individual strings
      • Redact individual files
      • Transcribe and redact an audio file
      • Configure entity type handling for redaction
      • Record and review redaction requests
    • Pipelines and parsing
      • Create and manage pipelines
      • Parse individual files
  • Textual REST API
    • About the Textual REST API
    • REST API authentication
    • Redaction
      • Redact text strings
  • Datasets
    • Manage datasets
    • Manage dataset files
  • Snowflake Native App and SPCS
    • About the Snowflake Native App
    • Setting up the app
    • Using the app
    • Using Textual with Snowpark Container Services directly
  • Install and administer Textual
    • Textual architecture
    • Setting up and managing a Textual Cloud pay-as-you-go subscription
    • Deploying a self-hosted instance
      • System requirements
      • Deploying with Docker Compose
      • Deploying on Kubernetes with Helm
    • Configuring Textual
      • How to configure Textual environment variables
      • Configuring the number of textual-ml workers
      • Configuring the number of jobs to run concurrently
      • Configuring the format of Textual logs
      • Setting a custom certificate
      • Configuring endpoint URLs for calls to AWS
      • Enabling PDF and image processing
      • Setting the S3 bucket for file uploads and redactions
      • Required IAM role permissions for Amazon S3
      • Configuring model preferences
    • Viewing model specifications
    • Managing user access to Textual
      • Textual organizations
      • Creating a new account in an existing organization
      • Single sign-on (SSO)
        • Viewing the list of SSO groups in Textual
        • Azure
        • GitHub
        • Google
        • Keycloak
        • Okta
      • Managing Textual users
      • Managing permissions
        • About permissions and permission sets
        • Built-in permission sets and available permissions
        • Viewing the lists of permission sets
        • Configuring custom permission sets
        • Configuring access to global permission sets
        • Setting initial access to all global permissions
    • Textual monitoring
      • Downloading a usage report
      • Tracking user access to Textual
Powered by GitBook
On this page
  • Built-in global permission sets
  • Available global permissions
  • Textual API and requests
  • Configuration management
  • Datasets and pipelines
  • Users and permissions
  • Built-in dataset permission sets
  • Available dataset permissions
  • General dataset management
  • Dataset file management
  • Built-in pipeline permission sets
  • Available pipeline permissions
  • General pipeline management
  • Pipeline file management

Was this helpful?

Export as PDF
  1. Install and administer Textual
  2. Managing user access to Textual
  3. Managing permissions

Built-in permission sets and available permissions

Last updated 25 days ago

Was this helpful?

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 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

✔️

✔️

environment variable