Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

docs: prefer publishable/secret key naming in SDK specs (#45372)

Katerina Skroumpelou89e291adecd8
diff --git a/apps/docs/spec/storage_v0_config.yaml b/apps/docs/spec/storage_v0_config.yaml
index fd45b2d862f..cf67ce0882a 100644
--- a/apps/docs/spec/storage_v0_config.yaml
+++ b/apps/docs/spec/storage_v0_config.yaml
@@ -5,9 +5,9 @@ info:
id: 'storage' # {string} A unique ID for this tool.
version: 'next' # {string} The current version number of the tool.
title: 'Storage' # {string} A readable name.
- source: 'https://github.com/supabase/storage-api' # {string} Where developers can find the source code.
- bugs: 'https://github.com/supabase/storage-api/issues' # {string} Where developers can file bugs.
- spec: 'https://github.com/supabase/supabase/blob/master/spec/storage_v1_config.yml' # {string} Where developers can find this spec (to link directly in the docs).
+ source: 'https://github.com/supabase/storage' # {string} Where developers can find the source code.
+ bugs: 'https://github.com/supabase/storage/issues' # {string} Where developers can file bugs.
+ spec: 'https://github.com/supabase/supabase/blob/master/spec/storage_v0_config.yml' # {string} Where developers can find this spec (to link directly in the docs).
description: |
A sample `.env` file is located in the [storage repository](https://github.com/supabase/storage-api/blob/master/.env.sample).
diff --git a/apps/docs/spec/supabase_dart_v2.yml b/apps/docs/spec/supabase_dart_v2.yml
index b41ba7c068d..2c646dac149 100644
--- a/apps/docs/spec/supabase_dart_v2.yml
+++ b/apps/docs/spec/supabase_dart_v2.yml
@@ -2114,15 +2114,15 @@ functions:
- id: admin-api
title: 'Overview'
notes: |
- - Any method under the `supabase.auth.admin` namespace requires a `service_role` key.
- - These methods are considered admin methods and should be called on a trusted server. Never expose your `service_role` key in the Flutter app.
+ - Any method under the `supabase.auth.admin` namespace requires a `secret` key.
+ - These methods are considered admin methods and should be called on a trusted server. Never expose your `secret` key in the Flutter app.
examples:
- id: create-auth-admin-client
name: Create server-side auth client
isSpotlight: true
code: |
```dart
- final supabase = SupabaseClient(supabaseUrl, serviceRoleKey);
+ final supabase = SupabaseClient(supabaseUrl, secretKey);
```
- id: get-user-by-id
title: 'getUserById()'
diff --git a/apps/docs/spec/supabase_js_v2.yml b/apps/docs/spec/supabase_js_v2.yml
index cd19b9770ab..8a36f7ebf9b 100644
--- a/apps/docs/spec/supabase_js_v2.yml
+++ b/apps/docs/spec/supabase_js_v2.yml
@@ -33,7 +33,7 @@ functions:
```js
import { createClient } from '@supabase/supabase-js'
- const supabase = createClient(supabase_url, anon_key)
+ const supabase = createClient(supabase_url, publishable_key)
```
- id: create-auth-client-server-side
name: Create auth client (server-side)
@@ -42,7 +42,7 @@ functions:
```js
import { createClient } from '@supabase/supabase-js'
- const supabase = createClient(supabase_url, anon_key, {
+ const supabase = createClient(supabase_url, publishable_key, {
auth: {
autoRefreshToken: false,
persistSession: false,
@@ -159,8 +159,8 @@ functions:
- id: admin-api
title: Overview
notes: |
- - Any method under the `supabase.auth.admin` namespace requires a `service_role` key.
- - These methods are considered admin methods and should be called on a trusted server. Never expose your `service_role` key in the browser.
+ - Any method under the `supabase.auth.admin` namespace requires a `secret` key.
+ - These methods are considered admin methods and should be called on a trusted server. Never expose your `secret` key in the browser.
examples:
- id: create-auth-admin-client
name: Create server-side auth client
@@ -169,7 +169,7 @@ functions:
```js
import { createClient } from '@supabase/supabase-js'
- const supabase = createClient(supabase_url, service_role_key, {
+ const supabase = createClient(supabase_url, secret_key, {
auth: {
autoRefreshToken: false,
persistSession: false
@@ -213,7 +213,7 @@ functions:
title: Custom OIDC/OAuth Provider Admin API
notes: |
- These methods allow you to manage custom OIDC/OAuth providers programmatically.
- - Requires `service_role` key.
+ - Requires `secret` key.
- Custom providers use the `custom:` prefix when signing in (e.g., `custom:my-oidc-provider`).
- id: admin-custom-providers-create
$ref: '@supabase/auth-js.GoTrueAdminCustomProvidersApi.createProvider'
@@ -590,7 +590,7 @@ functions:
notes: |
The OAuth Admin API allows you to manage OAuth clients programmatically.
Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
- These functions should only be called on a server. Never expose your `service_role` key in the browser.
+ These functions should only be called on a server. Never expose your `secret` key in the browser.
- id: auth-js-gotrueadminoauthapi-createclient
$ref: '@supabase/auth-js.GoTrueAdminOAuthApi.createClient'
- id: auth-js-gotrueadminoauthapi-deleteclient
diff --git a/apps/docs/spec/supabase_kt_v2.yml b/apps/docs/spec/supabase_kt_v2.yml
index 3edd417d4c0..00aa31721a2 100644
--- a/apps/docs/spec/supabase_kt_v2.yml
+++ b/apps/docs/spec/supabase_kt_v2.yml
@@ -127,7 +127,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Auth)
install(Postgrest)
@@ -140,7 +140,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Auth) {
alwaysAutoRefresh = false // default: true
@@ -197,7 +197,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Postgrest) {
defaultSchema = "schema" // default: "public"
@@ -219,7 +219,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Storage) {
transferTimeout = 90.seconds // Default: 120 seconds
@@ -246,7 +246,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Realtime) {
reconnectDelay = 5.seconds // Default: 7 seconds
@@ -273,7 +273,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Functions) {
//no custom settings
@@ -290,7 +290,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(GraphQL) {
apolloConfiguration {
@@ -2816,7 +2816,7 @@ functions:
isSpotlight: true
code: |
```kotlin
- val supabase = createSupabaseClient(supabaseURL = "https://xyzcompany.supabase.co'", supabaseKey = "publishable-or-anon-key") { ... }
+ val supabase = createSupabaseClient(supabaseUrl = "https://xyzcompany.supabase.co", supabaseKey = "your-publishable-key") { ... }
val auth = supabase.auth
```
- id: sign-up
@@ -3973,8 +3973,8 @@ functions:
- id: admin-api
title: 'Overview'
notes: |
- - Any method under the `supabase.auth.admin` namespace requires a `service_role` key.
- - These methods are considered admin methods and should be called on a trusted server. Never expose your `service_role` key in the browser.
+ - Any method under the `supabase.auth.admin` namespace requires a `secret` key.
+ - These methods are considered admin methods and should be called on a trusted server. Never expose your `secret` key in the browser.
examples:
- id: create-auth-admin-client
name: Create server-side auth client
@@ -3988,9 +3988,9 @@ functions:
install(Auth) {
minimalSettings() //disables session saving and auto-refreshing
}
- // install other plugins (these will use the service role key)
+ // install other plugins (these will use the secret key)
}
- supabase.auth.importAuthToken("service_role")
+ supabase.auth.importAuthToken("your-secret-key")
// Access auth admin api
val adminAuthClient = supabase.auth.admin
diff --git a/apps/docs/spec/supabase_kt_v3.yml b/apps/docs/spec/supabase_kt_v3.yml
index 11fc51f9c79..e4d058afdfa 100644
--- a/apps/docs/spec/supabase_kt_v3.yml
+++ b/apps/docs/spec/supabase_kt_v3.yml
@@ -132,7 +132,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Auth)
install(Postgrest)
@@ -145,7 +145,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Auth) {
alwaysAutoRefresh = false // default: true
@@ -202,7 +202,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Postgrest) {
defaultSchema = "schema" // default: "public"
@@ -228,7 +228,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Storage) {
transferTimeout = 90.seconds // Default: 120 seconds
@@ -255,7 +255,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Realtime) {
reconnectDelay = 5.seconds // Default: 7 seconds
@@ -282,7 +282,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(Functions) {
//no custom settings
@@ -299,7 +299,7 @@ functions:
```kotlin
val supabase = createSupabaseClient(
supabaseUrl = "https://xyzcompany.supabase.co",
- supabaseKey = "publishable-or-anon-key"
+ supabaseKey = "your-publishable-key"
) {
install(GraphQL) {
apolloConfiguration {
@@ -2911,7 +2911,7 @@ functions:
isSpotlight: true
code: |
```kotlin
- val supabase = createSupabaseClient(supabaseUrl = "https://xyzcompany.supabase.co'", supabaseKey = "publishable-or-anon-key") { ... }
+ val supabase = createSupabaseClient(supabaseUrl = "https://xyzcompany.supabase.co", supabaseKey = "your-publishable-key") { ... }
val auth = supabase.auth
```
- id: sign-up
@@ -4165,8 +4165,8 @@ functions:
- id: admin-api
title: 'Overview'
notes: |
- - Any method under the `supabase.auth.admin` namespace requires a `service_role` key.
- - These methods are considered admin methods and should be called on a trusted server. Never expose your `service_role` key in the browser.
+ - Any method under the `supabase.auth.admin` namespace requires a `secret` key.
+ - These methods are considered admin methods and should be called on a trusted server. Never expose your `secret` key in the browser.
examples:
- id: create-auth-admin-client
name: Create server-side auth client
@@ -4180,9 +4180,9 @@ functions:
install(Auth) {
minimalConfig() //disables session saving and auto-refreshing
}
- // install other plugins (these will use the service role key)
+ // install other plugins (these will use the secret key)
}
- supabase.auth.importAuthToken("service_role")
+ supabase.auth.importAuthToken("your-secret-key")
// Access auth admin api
val adminAuthClient = supabase.auth.admin
diff --git a/apps/docs/spec/supabase_py_v2.yml b/apps/docs/spec/supabase_py_v2.yml
index bc4c5e140bd..f3f22a14401 100644
--- a/apps/docs/spec/supabase_py_v2.yml
+++ b/apps/docs/spec/supabase_py_v2.yml
@@ -2135,8 +2135,8 @@ functions:
- id: admin-api
title: 'Overview'
notes: |
- - Any method under the `supabase.auth.admin` namespace requires a `service_role` key.
- - These methods are considered admin methods and should be called on a trusted server. Never expose your `service_role` key in the browser.
+ - Any method under the `supabase.auth.admin` namespace requires a `secret` key.
+ - These methods are considered admin methods and should be called on a trusted server. Never expose your `secret` key in the browser.
examples:
- id: create-auth-admin-client
name: Create server-side auth client
@@ -2148,7 +2148,7 @@ functions:
supabase = create_client(
supabase_url,
- service_role_key,
+ secret_key,
options=ClientOptions(
auto_refresh_token=False,
persist_session=False,
@@ -2168,7 +2168,7 @@ functions:
description: |
The user's unique identifier
- This function should only be called on a server. Never expose your `service_role` key in the browser.
+ This function should only be called on a server. Never expose your `secret` key in the browser.
notes: |
- Fetches the user object from the database based on the user's id.
- The `get_user_by_id()` method requires the user's id which maps to the `auth.users.id` column.
@@ -2397,8 +2397,8 @@ functions:
description: |
If true, then the user will be soft-deleted (setting `deleted_at` to the current timestamp and disabling their account while preserving their data) from the auth schema. Defaults to false for backward compatibility.
- This function should only be called on a server. Never expose your `service_role` key in the browser.
- description: Delete a user. Requires a `service_role` key.
+ This function should only be called on a server. Never expose your `secret` key in the browser.
+ description: Delete a user. Requires a `secret` key.
notes: |
- The `delete_user()` method requires the user's ID, which maps to the `auth.users.id` column.
examples:
@@ -2655,7 +2655,7 @@ functions:
description: |
The data you want to update.
- This function should only be called on a server. Never expose your `service_role` key in the browser.
+ This function should only be called on a server. Never expose your `secret` key in the browser.
subContent:
- name: app_metadata
isOptional: true
@@ -2825,7 +2825,7 @@ functions:
title: 'Overview'
notes: |
- OAuth 2.1 client administration endpoints are available via the `supabase.auth.admin.oauth` namespace.
- - These methods require a `service_role` key and should only be called server-side.
+ - These methods require a `secret` key and should only be called server-side.
- Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
- This is an alpha feature and may change in the future.
@@ -2834,7 +2834,7 @@ functions:
description: |
Lists OAuth clients with optional pagination.
notes: |
- - Requires `service_role` key.
+ - Requires `secret` key.
- Only available when OAuth 2.1 server is enabled.
- This is an alpha feature and may change in the future.
params:
@@ -2872,7 +2872,7 @@ functions:
description: |
Creates a new OAuth client.
notes: |
- - Requires `service_role` key.
+ - Requires `secret` key.
- Only available when OAuth 2.1 server is enabled.
- This is an alpha feature and may change in the future.
params:
@@ -2923,7 +2923,7 @@ functions:
description: |
Updates an existing OAuth client.
notes: |
- - Requires `service_role` key.
+ - Requires `secret` key.
- Only available when OAuth 2.1 server is enabled.
- This is an alpha feature and may change in the future.
params:
@@ -2971,7 +2971,7 @@ functions:
description: |
Retrieves details of an OAuth client by ID.
notes: |
- - Requires `service_role` key.
+ - Requires `secret` key.
- Only available when OAuth 2.1 server is enabled.
- This is an alpha feature and may change in the future.
params:
@@ -2992,7 +2992,7 @@ functions:
description: |
Deletes an OAuth client.
notes: |
- - Requires `service_role` key.
+ - Requires `secret` key.
- Only available when OAuth 2.1 server is enabled.
- This is an alpha feature and may change in the future.
params:
@@ -3013,7 +3013,7 @@ functions:
description: |
Regenerates the client secret for an OAuth client.
notes: |
- - Requires `service_role` key.
+ - Requires `secret` key.
- Only available when OAuth 2.1 server is enabled.
- This is an alpha feature and may change in the future.
params:
diff --git a/apps/docs/spec/supabase_swift_v2.yml b/apps/docs/spec/supabase_swift_v2.yml
index 426d84eafab..adb19e7bc40 100644
--- a/apps/docs/spec/supabase_swift_v2.yml
+++ b/apps/docs/spec/supabase_swift_v2.yml
@@ -27,7 +27,7 @@ functions:
```swift
import Supabase
- let client = SupabaseClient(supabaseURL: URL(string: "https://xyzcompany.supabase.co")!, supabaseKey: "publishable-or-anon-key")
+ let client = SupabaseClient(supabaseURL: URL(string: "https://xyzcompany.supabase.co")!, supabaseKey: "your-publishable-key")
```
- id: initialize-client-custom-options
name: Initialize Client with custom options
@@ -37,7 +37,7 @@ functions:
let supabase = SupabaseClient(
supabaseURL: URL(string: "https://xyzcompany.supabase.co")!,
- supabaseKey: "publishable-or-anon-key",
+ supabaseKey: "your-publishable-key",
options: SupabaseClientOptions(
db: .init(
schema: "public"
@@ -63,7 +63,7 @@ functions:
let supabase = SupabaseClient(
supabaseURL: URL(string: "https://xyzcompany.supabase.co")!,
- supabaseKey: "publishable-or-anon-key",
+ supabaseKey: "your-publishable-key",
options: SupabaseClientOptions(
db: .init(
// Disable automatic retries for this client
@@ -86,7 +86,7 @@ functions:
let supabase = SupabaseClient(
supabaseURL: URL(string: "https://xyzcompany.supabase.co")!,
- supabaseKey: "publishable-or-anon-key",
+ supabaseKey: "your-publishable-key",
options: SupabaseClientOptions(
global: SupabaseClientOptions.GlobalOptions(
logger: AppLogger()
@@ -102,7 +102,7 @@ functions:
let supabase = SupabaseClient(
supabaseURL: URL(string: "https://xyzcompany.supabase.co")!,
- supabaseKey: "publishable-or-anon-key",
+ supabaseKey: "your-publishable-key",
options: SupabaseClientOptions(
db: .init(
// Provide a custom schema. Defaults to "public".
@@ -174,7 +174,7 @@ functions:
isSpotlight: true
code: |
```swift
- let supabase = SupabaseClient(supabaseURL: URL(string: "https://xyzcompany.supabase.co")!, supabaseKey: "publishable-or-anon-key")
+ let supabase = SupabaseClient(supabaseURL: URL(string: "https://xyzcompany.supabase.co")!, supabaseKey: "your-publishable-key")
let auth = supabase.auth
```
- id: create-auth-client-with-custom-storage
@@ -184,7 +184,7 @@ functions:
```swift
let supabase = SupabaseClient(
supabaseURL: URL(string: "https://xyzcompany.supabase.co")!,
- supabaseKey: "publishable-or-anon-key",
+ supabaseKey: "your-publishable-key",
options: .init(
auth: .init(
MyCustomLocalStorage()
@@ -1350,8 +1350,8 @@ functions:
- id: admin-api
title: 'Overview'
notes: |
- - Any method under the `supabase.auth.admin` namespace requires a `service_role` key.
- - These methods are considered admin methods and should be called on a trusted server. Never expose your `service_role` key in the browser.
+ - Any method under the `supabase.auth.admin` namespace requires a `secret` key.
+ - These methods are considered admin methods and should be called on a trusted server. Never expose your `secret` key in the browser.
examples:
- id: create-auth-admin-client
name: Create server-side auth client
@@ -1362,7 +1362,7 @@ functions:
let supabase = SupabaseClient(
supabaseURL: supabaseURL,
- supabaseKey: serviceRoleKey
+ supabaseKey: secretKey
)
// Access auth admin api
@@ -1483,7 +1483,7 @@ functions:
description: |
List all OAuth clients with optional pagination.
notes: |
- - Requires `service_role` key.
+ - Requires `secret` key.
- This method is part of the OAuth 2.1 server administration API.
- Only works when the OAuth 2.1 server is enabled in your Supabase Auth configuration.
overwriteParams:
@@ -1515,7 +1515,7 @@ functions:
description: |
Create a new OAuth client.
notes: |
- - Requires `service_role` key.
+ - Requires `secret` key.
- This method is part of the OAuth 2.1 server administration API.
- Only works when the OAuth 2.1 server is enabled in your Supabase Auth configuration.
overwriteParams:
@@ -1543,7 +1543,7 @@ functions:
description: |
Get details of a specific OAuth client.
notes: |
- - Requires `service_role` key.
+ - Requires `secret` key.
- This method is part of the OAuth 2.1 server administration API.
overwriteParams:
- name: clientId
@@ -1566,7 +1566,7 @@ functions:
description: |
Delete an OAuth client.
notes: |
- - Requires `service_role` key.
+ - Requires `secret` key.
- This method is part of the OAuth 2.1 server administration API.
- This action cannot be undone.
overwriteParams:
@@ -1590,7 +1590,7 @@ functions:
description: |
Regenerate the secret for an OAuth client.
notes: |
- - Requires `service_role` key.
+ - Requires `secret` key.
- This method is part of the OAuth 2.1 server administration API.
- The old secret will be immediately invalidated.
- Make sure to update your application with the new secret.