> For the complete documentation index, see [llms.txt](https://docs.glue.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.glue.ai/developers/authentication/scopes.md).

# OAuth scopes

This document describes the OAuth scopes available in the Glue API. Scopes define what permissions an application has when accessing the API on behalf of a user.

## Scope Naming Convention

Scopes follow the pattern: `[admin.]<resource>:<action>[.subset]`

* `admin` - Optional prefix for admin-level permissions
* `resource-path` - Path to the resource (e.g., `threads`, `workspaces`)
* `action` - The action being performed (e.g., `read`, `write`)
* `subset` - Optional subset of the resource (e.g., `messages`)

## Available Scopes

### Read Scopes

#### `workspaces:read`

**Permission Level:** Standard\
**Description:** View workspace information\
**Capabilities:**

* Access workspace information like name, email domain, and avatarURL

#### `threads:read`

**Permission Level:** Standard\
**Description:** View thread information\
**Capabilities:**

* View basic information about publicly accessible threads in a workspace
* View basic information about threads the app is added to

#### `groups:read`

**Permission Level:** Standard\
**Description:** View group information\
**Capabilities:**

* View basic information about public groups in your workspace
* View basic information about groups that the app is added to

### Write Scopes

#### `threads.messages:write`

**Permission Level:** Standard\
**Description:** Send messages in threads, group chats and DMs\
**Capabilities:**

* Send messages as the app user to threads the app has access to
