Skip to content

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

docs: Update JS and Kotlin SDK reference (stripNulls, OAuth 2.1 admin) (#44959)

Guilherme Souzabc863816fb99
diff --git a/apps/docs/spec/common-client-libs-sections.json b/apps/docs/spec/common-client-libs-sections.json
index 813b0b21c49..0f1559522bb 100644
--- a/apps/docs/spec/common-client-libs-sections.json
+++ b/apps/docs/spec/common-client-libs-sections.json
@@ -368,6 +368,14 @@
"parent": "modifiers",
"type": "function"
},
+ {
+ "id": "strip-nulls",
+ "title": "Strip null values",
+ "slug": "db-strip-nulls",
+ "product": "database",
+ "parent": "modifiers",
+ "type": "function"
+ },
{
"id": "returns",
"title": "Override type of successful response",
@@ -893,6 +901,48 @@
"slug": "auth-admin-oauth-regenerateclientsecret",
"product": "auth-admin",
"type": "function"
+ },
+ {
+ "id": "admin-oauth-list-clients",
+ "title": "List OAuth clients",
+ "slug": "auth-admin-oauth-listclients",
+ "product": "auth-admin",
+ "type": "function"
+ },
+ {
+ "id": "admin-oauth-create-client",
+ "title": "Create OAuth client",
+ "slug": "auth-admin-oauth-createclient",
+ "product": "auth-admin",
+ "type": "function"
+ },
+ {
+ "id": "admin-oauth-get-client",
+ "title": "Get OAuth client",
+ "slug": "auth-admin-oauth-getclient",
+ "product": "auth-admin",
+ "type": "function"
+ },
+ {
+ "id": "admin-oauth-update-client",
+ "title": "Update OAuth client",
+ "slug": "auth-admin-oauth-updateclient",
+ "product": "auth-admin",
+ "type": "function"
+ },
+ {
+ "id": "admin-oauth-delete-client",
+ "title": "Delete OAuth client",
+ "slug": "auth-admin-oauth-deleteclient",
+ "product": "auth-admin",
+ "type": "function"
+ },
+ {
+ "id": "admin-oauth-regenerate-client-secret",
+ "title": "Regenerate client secret",
+ "slug": "auth-admin-oauth-regenerateclientsecret",
+ "product": "auth-admin",
+ "type": "function"
}
]
}
diff --git a/apps/docs/spec/supabase_js_v2.yml b/apps/docs/spec/supabase_js_v2.yml
index 6b2d34c52d8..efd08fbf093 100644
--- a/apps/docs/spec/supabase_js_v2.yml
+++ b/apps/docs/spec/supabase_js_v2.yml
@@ -452,6 +452,8 @@ functions:
$ref: '@supabase/postgrest-js.PostgrestTransformBuilder.maybeSingle'
- id: csv
$ref: '@supabase/postgrest-js.PostgrestTransformBuilder.csv'
+ - id: strip-nulls
+ $ref: '@supabase/postgrest-js.PostgrestTransformBuilder.stripNulls'
- id: returns
$ref: '@supabase/postgrest-js.PostgrestTransformBuilder.returns'
- id: overrideTypes
diff --git a/apps/docs/spec/supabase_kt_v3.yml b/apps/docs/spec/supabase_kt_v3.yml
index a55bc9f536e..27b4cd1ae19 100644
--- a/apps/docs/spec/supabase_kt_v3.yml
+++ b/apps/docs/spec/supabase_kt_v3.yml
@@ -3116,6 +3116,10 @@ functions:
isOptional: true
type: String?
description: The captcha token when having captcha enabled.
+ - name: data
+ isOptional: true
+ type: JsonObject?
+ description: '**Deprecated** — use `extraData` or user metadata on the sign-up flow instead. Will be removed in a future release.'
examples:
- id: sign-in-with-id-token
@@ -3127,9 +3131,6 @@ functions:
provider = Google //Also supported: Apple, Azure and Facebook
//optional:
nonce = "nonce"
- data = buildJsonObject {
- //...
- }
}
```
- id: sign-in-with-otp
@@ -4576,6 +4577,118 @@ functions:
```kotlin
supabase.auth.admin.deleteFactor(uid = "id", factorId = "factor_id")
```
+ - id: oauth-admin-api
+ title: OAuth Admin API
+ 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 `secret key` in the browser.
+ - id: admin-oauth-list-clients
+ title: 'admin.oauth.listClients()'
+ notes: |
+ Lists all OAuth 2.1 clients. Requires a `secret key`.
+ params:
+ - name: page
+ isOptional: true
+ type: Int?
+ description: The page number for pagination.
+ - name: perPage
+ isOptional: true
+ type: Int?
+ description: The number of results per page.
+ examples:
+ - id: list-oauth-clients
+ name: List all OAuth clients
+ isSpotlight: true
+ code: |
+ ```kotlin
+ val clients = supabase.auth.admin.oauth.listClients()
+ ```
+ - id: admin-oauth-create-client
+ title: 'admin.oauth.createClient()'
+ notes: |
+ Creates a new OAuth 2.1 client. Requires a `secret key`.
+ examples:
+ - id: create-oauth-client
+ name: Create an OAuth client
+ isSpotlight: true
+ code: |
+ ```kotlin
+ val client = supabase.auth.admin.oauth.createClient {
+ name = "My App"
+ redirectUris = listOf("https://example.com/callback")
+ }
+ ```
+ - id: admin-oauth-get-client
+ title: 'admin.oauth.getClient()'
+ notes: |
+ Retrieves an OAuth 2.1 client by ID. Requires a `secret key`.
+ params:
+ - name: clientId
+ isOptional: false
+ type: String
+ description: The ID of the OAuth client to retrieve.
+ examples:
+ - id: get-oauth-client
+ name: Get an OAuth client
+ isSpotlight: true
+ code: |
+ ```kotlin
+ val client = supabase.auth.admin.oauth.getClient(clientId = "client_id")
+ ```
+ - id: admin-oauth-update-client
+ title: 'admin.oauth.updateClient()'
+ notes: |
+ Updates an existing OAuth 2.1 client. Requires a `secret key`.
+ params:
+ - name: clientId
+ isOptional: false
+ type: String
+ description: The ID of the OAuth client to update.
+ examples:
+ - id: update-oauth-client
+ name: Update an OAuth client
+ isSpotlight: true
+ code: |
+ ```kotlin
+ val client = supabase.auth.admin.oauth.updateClient(clientId = "client_id") {
+ name = "Updated App Name"
+ }
+ ```
+ - id: admin-oauth-delete-client
+ title: 'admin.oauth.deleteClient()'
+ notes: |
+ Deletes an OAuth 2.1 client. Requires a `secret key`.
+ params:
+ - name: clientId
+ isOptional: false
+ type: String
+ description: The ID of the OAuth client to delete.
+ examples:
+ - id: delete-oauth-client
+ name: Delete an OAuth client
+ isSpotlight: true
+ code: |
+ ```kotlin
+ supabase.auth.admin.oauth.deleteClient(clientId = "client_id")
+ ```
+ - id: admin-oauth-regenerate-client-secret
+ title: 'admin.oauth.regenerateClientSecret()'
+ notes: |
+ Regenerates the client secret for an OAuth 2.1 client. Requires a `secret key`.
+ params:
+ - name: clientId
+ isOptional: false
+ type: String
+ description: The ID of the OAuth client whose secret should be regenerated.
+ examples:
+ - id: regenerate-client-secret
+ name: Regenerate client secret
+ isSpotlight: true
+ code: |
+ ```kotlin
+ val client = supabase.auth.admin.oauth.regenerateClientSecret(clientId = "client_id")
+ ```
- id: invoke
title: 'invoke()'
description: |