Start social authentication REST API

POST

/api/auth/social/{provider}/start

curl --request POST \
  --url http://127.0.0.1:25737/api/auth/social/google/start \
  --header 'Content-Type: application/json' \
  --data '{ "flow": "login", "invite_token": "example", "remember_me": true, "return_url": "example" }'

Starts a login, signup, or invitation flow using authorization code, browser-bound one-time state, PKCE S256, and an OIDC nonce where applicable. Return URLs are restricted to safe local application paths.

Parameters

Path Parameters

provider

required

string

Allowed values: google github microsoft

Request Body^required

Media typeapplication/json

object

flow

required

string

Allowed values: login signup invite

invite_token

string

remember_me

boolean

return_url

Optional safe local application path.

string

Responses

200

Provider authorization URL

Media typeapplication/json

object

auth_url

required

string format: uri

Example^generated

{
  "auth_url": "https://example.com"
}

400

Invalid flow

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

404

Provider or social signup unavailable

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

503

Provider unavailable

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}