Facebook Sign In

Authenticates a user using a Facebook access token (from Facebook SDK / Login). The token is validated via Facebook Graph API debug_token; it must be valid and issued for the configured Facebook app (app_id match). On success, returns token envelope; downstream may create/update user and issue tokens.

Headers

X-Correlation-Id
Type: string

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

Body

required

application/json

access_token
Type: string
required

Facebook user access token from Facebook SDK / Login flow.
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.
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 WebFacebook).
values
- WebFacebook
- MobileFacebook

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json

post/api2/social/facebook/signin

curl https://SERVER_NAME_GOES_HERE/api2/social/facebook/signin \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "client": "CLIENT_GOES_HERE",
  "access_token": "ACCESS_TOKEN_GOES_HERE",
  "signup_channel": "WebFacebook",
  "privacy_policy": true,
  "terms_and_conditions": true
}'

Show Schema

{
  "data": {
    "access_token": "ACCESS_TOKEN_GOES_HERE",
    "token_type": "Bearer",
    "refresh_token": "REFRESH_TOKEN_GOES_HERE",
    "expires_in": 86400
  }
}

Authentication successful; tokens issued