Scopes
Specify the level of access that you need using granular OAuth scopes.
The available scopes for an OAuth Application are configured when the application is created.
Additionally the required scopes for a particular workload need to be specified when requesting an access token. See the documentation for the Grant Type that you're using for how to do this.
Available Scopes for GraphQL
The following scopes are available for use in the Bipsync GraphQL API:
| Scope | Description |
|---|---|
attachments:read | Read attachments on notes, projects and categories. |
categories:read | Read categories. |
classifications:read | Read classifications. |
comments:read | Read comments. |
contacts:read | Read contacts. |
events:read | Read events. |
external_ids:read | Read external IDs. |
fields:read | Read field definitions. |
groups:read | Read user groups. |
note_templates:read | Read note templates |
pipelines:read | Read pipelines and stages. |
projects:read | Read projects. |
research:read | Read research (notes and files). |
tasks:read | Read tasks. |
users:read | Read users. |
versions:read | Read versions. |
Available Scopes for the REST API
The following scopes are available for use in the Bipsync REST API:
| Scope | Description |
|---|---|
rest_api:read | Access REST API GET endpoints. |
rest_api:fields:read | Access the REST API v1/field endpoint. |
rest_api:write | Access REST API DELETE/POST/PUT endpoints. |
Updated 10 days ago
