Examplary
Start for free
Developer docs

OAuth scopes

Every OAuth scope available on the Examplary API, with the access each one grants.

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.

ScopeDescription
openidAuthenticate using OpenID Connect
profileAccess your basic profile information
emailRead 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.

ScopeDescription
profile:writeUpdate your profile information
exams:readView your tests and questions
exams:writeUpdate, and delete tests and questions
question-types:readView available question types
question-types:writeCreate and manage question types
embed-sessions:manageCreate and manage embed sessions
embed-sessions:update-runtime-outputsUpdate runtime outputs for embed sessions
folders:readView folders
folders:writeCreate, update, and delete folders
items:readView tests and practice spaces
source-materials:readView source materials
source-materials:writeCreate, update, and delete source materials
question-bank:readView question bank items
question-bank:writeCreate, update, and delete question bank items
orgs:readView workspace settings
orgs:writeUpdate workspace settings
audit-logs:readView audit logs
audit-logs:writeAdd entries to the audit log
users:readView workspace members
users:writeManage workspace members
permissions:readView sharing permissions
permissions:writeManage sharing permissions
media:writeUpload media files
billing:readView billing information
billing:writeManage billing and subscriptions
api-keys:readView API keys
api-keys:writeManage API keys
oauth-clients:readView OAuth applications
oauth-clients:writeManage OAuth applications
taxonomies:readView taxonomies and student levels
taxonomies:writeCreate, update, and delete taxonomies
library:readView library collections and items
library:writeManage library collections and items
support:writeSubmit support requests and feedback
rubrics:readView rubrics
rubrics:writeCreate, update, and delete rubrics
prompts:readView prompts
prompts:writeCreate, update, and delete prompts
practice-spaces:readView practice spaces
practice-spaces:writeCreate, update, and delete practice spaces
jobs:readView background job statuses
jobs:writeManage background jobs
webhooks:readView webhooks and their deliveries
webhooks:writeCreate and delete webhooks
attributes:readView custom attributes
attributes:writeCreate, update, and delete custom attributes
integrations:readView org integrations and their settings
integrations:writeConfigure and remove org integrations
apps:readView apps, and the workspace's and your own installed apps
apps:writePublish apps, and install or remove them
admin:writeFull system admin access
ai:generateUse AI generation features