forked from supabase/supabase
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add oauth scopes definitions (supabase#18169)
* docs: add oauth scopes definitions * docs: resolve comments
- Loading branch information
1 parent
504a4ce
commit e320510
Showing
2 changed files
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
apps/docs/pages/guides/platform/oauth-apps/oauth-scopes.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
import Layout from '~/layouts/DefaultGuideLayout' | ||
|
||
export const meta = { | ||
id: 'oauth-scopes', | ||
title: 'Scopes for your OAuth App', | ||
description: 'Scopes let you specify the level of access your integration needs', | ||
subtitle: 'Scopes let you specify the level of access your integration needs', | ||
} | ||
|
||
<Admonition type="note"> | ||
|
||
Scopes are only available for OAuth apps. Check out [**our guide**](/docs/guides/platform/oauth-apps/build-a-supabase-integration) to learn how to build an OAuth app integration. | ||
|
||
</Admonition> | ||
|
||
Scopes restrict access to the specific [Supabase Management API endpoints](/docs/reference/api/introduction) for OAuth tokens. All scopes can be specified as read and/or write. | ||
|
||
## Available Scopes | ||
|
||
| Name | Type | Description | | ||
| ---------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| `Auth` | `Read` | Retrieve a project's auth configuration<br/>Retrieve a project's SAML SSO providers | | ||
| `Auth` | `Write` | Update a project's auth configuration<br/>Create, update, or delete a project's SAML SSO providers | | ||
| `Database` | `Read` | Retrieve the database configuration<br/>Retrieve SQL snippets<br/>Check if the database is in read-only mode<br/>Retrieve a database's SSL enforcement configuration<br/>Retrieve a database's schema typescript types | | ||
| `Database` | `Write` | Create a SQL query<br/>Enable database webhooks on the project<br/>Update the project's database configration<br/>Update a database's SSL enforcement configration<br/>Disable read-only mode for 15mins<br/>Retrieve the pgbouncer configuration<br/>Create a PITR backup for a database | | ||
| `Domains` | `Read` | Retrieve the custom domains for a project<br/>Retrieve the vanity subdomain configuration for a project | | ||
| `Domains` | `Write` | Activate, intialise, reverify, or delete the custom domain for a project<br/>Activate, delete or check the availability of a vanity subdomain for a project | | ||
| `Edge Functions` | `Read` | Retrieve information about a project's edge functions | | ||
| `Edge Functions` | `Write` | Create, update, or delete an edge function | | ||
| `Environment` | `Read` | Retrieve branches in a project | | ||
| `Environment` | `Write` | Create, update, or delete a branch | | ||
| `Organizations` | `Read` | Retrieve an organization's metadata<br/>Retrieve all members in an organization | | ||
| `Organizations` | `Write` | Create an organization | | ||
| `Projects` | `Read` | Retrieve a project's metadata<br/>Check if a project's database is eligible for upgrade<br/>Retrieve a project's network restrictions<br/>Retrieve a project's network bans | | ||
| `Projects` | `Write` | Create a project<br/>Upgrade a project's database<br/>Remove a project's network bans<br/>Update a project's network restrictions | | ||
| `Rest` | `Read` | Retrieve a project's PostgREST configuration | | ||
| `Rest` | `Write` | Update a project's PostgREST configuration | | ||
| `Secrets` | `Read` | Retrieve a project's API keys<br/>Retrieve a project's secrets<br/>Retrieve a project's pgsodium config | | ||
| `Secrets` | `Write` | Create or update a project's secrets<br/>Update a project's pgsodium configuration | | ||
|
||
export const Page = ({ children }) => <Layout meta={meta} children={children} /> | ||
|
||
export default Page |