API Reference
PUT
/api/platform/v1/users/{userId}

Updates a user's connection limits.

Authorization

BasicAuth
AuthorizationBasic <token>

Management endpoints: use client_id as username and client_secret as password.

In: header

Path Parameters

userId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/api/platform/v1/users/string" \  -H "Content-Type: application/json" \  -d '{    "limits": {      "us_ca_connections_limit": 0,      "international_connections_limit": 0    }  }'
{
  "user": {
    "user_id": "string",
    "external_user_id": "string",
    "email": "string",
    "limits": {
      "us_ca_connections_limit": 0,
      "international_connections_limit": 0
    }
  }
}
{
  "error": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string"
}

Register a user POST

Creates or retrieves a platform user for this app. Returns a user_id, access_token, and refresh_token. Use the access_token as a Bearer token for data endpoints.

Delete a user DELETE

Removes a user from this app and revokes their tokens. Does not delete the underlying Supabase auth user.