OAuth applications request access to a user's Examplary data through scopes. The user sees every requested scope on the authorization screen, so request only what your application needs — see Sign in with Examplary for how to request them. The reference page for each endpoint lists the scopes it requires under Requirements.
Default scopes
These scopes are granted to every application automatically and only provide basic sign-in and profile information.
| Scope | Description |
|---|---|
openid | Authenticate using OpenID Connect |
profile | Access your basic profile information |
email | Read your email address |
Resource scopes
Access to a user's Examplary data must be requested explicitly. Most resources follow a resource:read / resource:write pattern.
| Scope | Description |
|---|---|
profile:write | Update your profile information |
exams:read | View your tests and questions |
exams:write | Update, and delete tests and questions |
question-types:read | View available question types |
question-types:write | Create and manage question types |
embed-sessions:manage | Create and manage embed sessions |
embed-sessions:update-runtime-outputs | Update runtime outputs for embed sessions |
folders:read | View folders |
folders:write | Create, update, and delete folders |
items:read | View tests and practice spaces |
source-materials:read | View source materials |
source-materials:write | Create, update, and delete source materials |
question-bank:read | View question bank items |
question-bank:write | Create, update, and delete question bank items |
orgs:read | View workspace settings |
orgs:write | Update workspace settings |
audit-logs:read | View audit logs |
users:read | View workspace members |
users:write | Manage workspace members |
permissions:read | View sharing permissions |
permissions:write | Manage sharing permissions |
media:write | Upload media files |
billing:read | View billing information |
billing:write | Manage billing and subscriptions |
api-keys:read | View API keys |
api-keys:write | Manage API keys |
oauth-clients:read | View OAuth applications |
oauth-clients:write | Manage OAuth applications |
taxonomies:read | View taxonomies and student levels |
taxonomies:write | Create, update, and delete taxonomies |
library:read | View library publishers and items |
library:write | Manage library publishers and items |
support:write | Submit support requests and feedback |
rubrics:read | View rubrics |
rubrics:write | Create, update, and delete rubrics |
prompts:read | View prompts |
prompts:write | Create, update, and delete prompts |
practice-spaces:read | View practice spaces |
practice-spaces:write | Create, update, and delete practice spaces |
jobs:read | View background job statuses |
jobs:write | Manage background jobs |
attributes:read | View custom attributes |
attributes:write | Create, update, and delete custom attributes |
integrations:read | View org integrations and their settings |
integrations:write | Configure and remove org integrations |
admin:write | Full system admin access |
ai:generate | Use AI generation features |