OAuth connect_
Connect your platform to users' Appwrite accounts with OAuth 2.0. Request consent to manage organizations and projects on their behalf.
2 min read
OAuth connect lets your platform access a user's Appwrite organizations after they sign in and grant consent. Use it when customers already have Appwrite accounts and want to link them to your product without sharing passwords or API keys.
How it works
- Register an OAuth app in your Appwrite organization settings
- Redirect users to Appwrite's authorization endpoint with your client ID and requested scopes
- After consent, exchange the authorization code for access and refresh tokens on your server
- Call Console APIs with the user's delegated access token
Your platform never stores the user's Appwrite password. Access is limited to the scopes the user approved and can be revoked from Appwrite.
When to use OAuth connect
Choose OAuth connect when:
- Users manage their own Appwrite organizations
- You need explicit consent before accessing org or project data
- Your product enhances an existing Appwrite workflow rather than provisioning new orgs
For platform-owned provisioning inside your organization, use Org API keys instead or alongside OAuth connect.
Getting started
Marketplaces
Publish OAuth apps and run install flows for organization admins.
Setup
Register an OAuth app and implement the authorization flow.
Scopes
Request the minimum Console scopes your integration needs.
Related
OAuth connect is different from OAuth2 login in project Auth, which authenticates end users of your app. Partner OAuth connect authorizes your platform to call Console APIs for a user's organizations.
Was this page helpful?
Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.