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:

ScopeDescription
attachments:readRead attachments on notes, projects and categories.
categories:readRead categories.
classifications:readRead classifications.
comments:readRead comments.
contacts:readRead contacts.
events:readRead events.
external_ids:readRead external IDs.
fields:readRead field definitions.
groups:readRead user groups.
note_templates:readRead note templates
pipelines:readRead pipelines and stages.
projects:readRead projects.
research:readRead research (notes and files).
tasks:readRead tasks.
users:readRead users.
versions:readRead versions.

Available Scopes for the REST API

The following scopes are available for use in the Bipsync REST API:

ScopeDescription
rest_api:readAccess REST API GET endpoints.
rest_api:fields:readAccess the REST API v1/field endpoint.
rest_api:writeAccess REST API DELETE/POST/PUT endpoints.