Sign in

v21

OpenAPI 3.1.0raw.githubusercontent.com2026-08-011060456.0 KB
Oauth

Create an OAuth provider

Add a new OAuth provider for a user.

post/oauth-providers

Request body

user_idstring required

The ID of the user, or the special value me for the currently authenticated user

provider_config_idstring required
emailstring

Email of the OAuth provider. This is used to display and identify the OAuth provider in the UI.

allow_sign_inboolean required

Whether the user can use this OAuth provider to sign in. Only one OAuth provider per type can have this set to true.

allow_connected_accountsboolean required

Whether the user can use this OAuth provider as connected account. Multiple OAuth providers per type can have this set to true.

account_idstring required

Account ID of the OAuth provider. This uniquely identifies the account on the provider side.

Example request

{
  "user_id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "email": "test@gmail.com",
  "allow_sign_in": true,
  "allow_connected_accounts": true,
  "account_id": "google-account-id-12345"
}

Response

Successful response

account_idstring required

Account ID of the OAuth provider. This uniquely identifies the account on the provider side.

user_idstring required

The ID of the user, or the special value me for the currently authenticated user

idstring required

The unique identifier of the OAuth provider

emailstring

Email of the OAuth provider. This is used to display and identify the OAuth provider in the UI.

provider_config_idstring required

Provider config ID of the OAuth provider. This uniquely identifies the provider config on config.json file

type'google' | 'github' | 'microsoft' | 'spotify' | 'facebook' | 'discord' | 'gitlab' | 'bitbucket' | 'linkedin' | 'apple' | 'x' | 'twitch' required

OAuth provider type, one of google, github, microsoft, spotify, facebook, discord, gitlab, bitbucket, linkedin, apple, x, twitch

allow_sign_inboolean required

Whether the user can use this OAuth provider to sign in. Only one OAuth provider per type can have this set to true.

allow_connected_accountsboolean required

Whether the user can use this OAuth provider as connected account. Multiple OAuth providers per type can have this set to true.

Example response

{
  "account_id": "google-account-id-12345",
  "user_id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "id": "b3d396b8-c574-4c80-97b3-50031675ceb2",
  "email": "test@gmail.com",
  "provider_config_id": "google",
  "type": "google",
  "allow_sign_in": true,
  "allow_connected_accounts": true
}