Scope reference

OAuth scopes that gate access to platform resources. 70 scopes across 4 verbs.

Verbs

• read: — view this resource
• write: — create or modify this resource
• manage: — full control (implies read + write)
• admin: — system-only, never granted to third parties

By verb

admin

• admin:accounting
• admin:affiliates
• admin:ai
• admin:analytics
• admin:booking
• admin:capri
• admin:cash
• admin:clinical
• admin:commerce
• admin:comms
• admin:community
• admin:content
• admin:entitlements
• admin:events
• admin:follows
• admin:identity
• admin:integrations
• admin:jobs
• admin:live
• admin:membership
• admin:patient_graph
• admin:payments
• admin:platform
• admin:webhooks

manage

• manage:affiliate_winback
• manage:connected_apps
• manage:inbox
• manage:preferences
• manage:subscriptions

read

• read:account
• read:affiliate_customers
• read:affiliate_self
• read:analytics
• read:biomarkers
• read:cash_balance
• read:check_ins
• read:clinical
• read:community
• read:content
• read:entitlements
• read:follows
• read:inbox
• read:invoices
• read:lab_catalog
• read:lab_orders
• read:lab_results
• read:live
• read:membership
• read:my_outcomes
• read:payments
• read:physicians
• read:preferences
• read:profile
• read:protocols
• read:recommendations
• read:red_flags
• read:research_papers
• read:subscriptions
• read:wearables

write

• write:biomarkers
• write:check_ins
• write:clinical
• write:community
• write:follows
• write:lab_orders
• write:live
• write:messages
• write:physicians
• write:protocols
• write:wearables

Related

• Auth model
• Connect — Scopes
• Scope enforcement (requireScope)