TrieOH
IdentityXAPIAuthn

Start a social login

Starts the social login process for the given provider (`google` or `github`) and returns the redirect URL the client should send the user to. After the user authorizes, the provider redirects back to `/auth/{provider}/callback?code=...`.

GET/auth/{provider}/connect

Starts the social login process for the given provider (google or github) and returns the redirect URL the client should send the user to. After the user authorizes, the provider redirects back to /auth/{provider}/callback?code=....

Path Parameters

provider*string

Social identity provider

Query Parameters

project_id?string

Project to scope the operation to. Omit for IdentityX itself.

accepted_tos?boolean

Explicit consent to the project's current terms of service. Required (true) when the project has terms and the flow may register a first-time identity; ignored otherwise. The consent screen must precede the provider redirect.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/auth/google/connect"
{
  "url": "http://example.com"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 400,
  "title": "Validation Failed"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 500,
  "title": "Internal Server Error"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 503,
  "title": "Identity Unavailable"
}

Refresh a user session POST

Exchanges a refresh token (sent in the `Refresh-Token` header) for a fresh access/refresh token pair. Use when the access token is about to expire or has expired.

Conclude a social login GET

Receives the callback from the social login redirect, exchanges the authorization `code` for tokens, and finishes user authentication. Returns the token pair with 201 on first-time OAuth logins (account created implicitly).