Google Sign In

Authenticates a user using a Google ID token (JWT). The token is validated server-side. On success, issues access and refresh tokens. If the user does not exist, a new account is created automatically.

Headers
  • X-Correlation-Id
    Type: string

    Optional caller-provided correlation ID; echoed in responses when present.

Body
required
application/json
  • client
    Type: string
    required

    OAuth client ID provided by the business. Required to identify the client application for authentication. The OAuth application must have the Advance Auth scope enabled.

  • google_id_token
    Type: string Format: jwt
    required

    Google ID token (JWT) obtained from Google Sign-In flow.

  • privacy_policy
    Type: boolean
    required

    Must be true to allow signup.

  • terms_and_conditions
    Type: boolean
    required

    Must be true to allow signup.

  • signup_channel
    Type: string enum

    Signup channel identifier (optional, defaults to WebGoogle).

    values
    • WebGoogle
    • MobileGoogle
Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/api2/social/google/signin
curl https://SERVER_NAME_GOES_HERE/api2/social/google/signin \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "client": "CLIENT_GOES_HERE",
  "google_id_token": "GOOGLE_ID_TOKEN_GOES_HERE",
  "signup_channel": "WebGoogle",
  "privacy_policy": true,
  "terms_and_conditions": true
}'
{
  "data": {
    "access_token": "ACCESS_TOKEN_GOES_HERE",
    "token_type": "Bearer",
    "refresh_token": "REFRESH_TOKEN_GOES_HERE",
    "expires_in": 86400
  }
}