Docs
Skip to content

OAuth connect

OAuth connect scopes_

Request the right Console OAuth scopes when connecting to user Appwrite accounts from your partner platform.

2 min read

Raw

OAuth scopes define what your platform can do after a user grants consent. Request only the scopes required for your integration.

Scope principles

  • Start with read-only scopes if your product only displays Appwrite data
  • Add write scopes when your platform creates or updates resources
  • Separate scopes for organizations, projects, and domains where possible
  • Document which features require which scopes in your product UI

Common scope categories

CategoryTypical use
Organization readList organizations the user belongs to
Organization writeCreate or update organization settings
Projects readList and inspect projects
Projects writeCreate projects and update project settings
Domains readList organization domains and DNS
Domains writeRegister domains and manage DNS records

Exact scope names are listed in the Appwrite Console when you configure your OAuth app.

Least privilege

If your platform only provisions projects inside organizations the user selects, request project write scopes without domain write unless you manage hostnames.

If users can disconnect your integration, delete stored tokens and stop calling Console APIs immediately.

Was this page helpful?

Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.