Skip to content

docs: OAuth server section and Sign in with your product guide#3096

Draft
atharvadeosthale wants to merge 14 commits into
projects-apifrom
stardust-oauth
Draft

docs: OAuth server section and Sign in with your product guide#3096
atharvadeosthale wants to merge 14 commits into
projects-apifrom
stardust-oauth

Conversation

@atharvadeosthale

Copy link
Copy Markdown
Member

OAuth server documentation

Adds a new OAuth server section under Partners, covering Appwrite's OAuth 2.1 / OpenID Connect provider capability: turning a project into an OAuth provider so third-party apps can "Sign in with your product".

Reference and concept pages

Under docs/partners/oauth-server:

  • Overview — what the OAuth server is and how the pieces fit together
  • Quick start — enable the server, register a client, run a first sign-in
  • Clients — confidential vs public clients, secrets, and management
  • Authorization — the authorization code flow, PKCE, and hosting a consent screen
  • Tokens — access, refresh, and ID tokens, lifetimes, introspection, and revocation
  • Scopes — the built-in OpenID scopes and custom scopes
  • Device flow — the device authorization grant for TVs and CLIs

Code samples cover all supported client and server SDKs alongside raw HTTP.

Guide: Sign in with your product

A step-by-step tutorial that builds a complete "Sign in with your product" experience end to end with TanStack Start: a provider that hosts the consent screen and a consumer that adds the sign-in button and exchanges the code for tokens server-side.

The finished code lives in a companion repository: appwrite-community/oauth-guide-taskflow.

Notes

  • New OAuth server entry added to the Partners group in the docs sidebar.
  • Screenshots captured in both light and dark themes and optimized to AVIF.

Opened as a draft against projects-api.

@appwrite

appwrite Bot commented Jul 10, 2026

Copy link
Copy Markdown

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Failed Failed View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Queued Queued View Logs Preview URL QR Code


Tip

Preview deployments create instant URLs for every branch and commit

- New 7-step tutorial: define scopes, per-scope consent, JWKS-validated
  resource server, and a consumer exercised against it end to end
- Scopes page: authorize examples for requesting scopes, and a rich
  authorization requests (RFC 9396) section with configuration,
  request, consent, and enforcement
- Trim the quick start discovery snippet and overview framing; split
  client types into bullets
… tasks.write)

Aligns the custom-scopes tutorial and announcement blog with the dot notation used by the scopes reference and device-flow pages. Retakes the console and Vantage screenshots that displayed the old names.
Mermaid-rendered flow diagrams (light and dark) placed after the concept heading on the overview, authorization, clients, tokens, scopes, and device-flow pages.
Moves docs/partners/oauth-server to docs/products/auth/oauth-server, rewrites all internal links, links it from the Auth sidebar with a new badge until 30 Aug, and resets the section layout to avoid nesting inside the Auth layout.
Adds RFC 9207 to the standards table (verified in cloud main), applies the reviewed PAR wording, removes the settings screenshot from the overview, reworks the clients diagram to contrast the confidential and public token exchange flows, and redraws the authorization and device-flow diagrams as flowcharts with the second device called out.
Session secret placeholder in cookie examples, four components on the overview, marketplace wording, approve/reject terminology, discovery URL purpose, HTTPS redirect URI rule with https example URLs, public client pointer, type param in create examples, full-parameter update examples verified live, state removed from the quick start, approve section restructured as prose with devtools cookie instructions, and a provider docs and developer platform note in next steps.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant