Social login

Exchanges a social provider token for an InCrowd / FanScore access token.

The providerToken is validated against the named provider — a Google or Apple id_token, or a Facebook access token — using the configuration registered for the supplied clientId. If the provider identity has not been seen before, a Cortex SSO user is provisioned from the profile returned by the provider and a mapping is stored; otherwise the existing mapping is used.

The endpoint is unauthenticated: the providerToken in the body is the only credential.

Some clients require a first and last name on the provider profile before a new user can be created. Where the provider does not return them — Apple only supplies them on first authorisation — pass them in metadata.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The social provider that issued the token. Builds running the local profile also register an additional mock provider, which is not available in deployed environments.

Allowed:
string
required

The token issued by the provider — an id_token for Google and Apple, an access token for Facebook.

string
required

Identifier of the client the login is being performed against.

uuid
required

Identifier of the device making the request. Must be a version 4 UUID.

metadata
object | null

Additional provider-specific profile fields. Apple returns the user's name only on first authorisation, so it is passed here.

string | null

Source recorded against the user when a new account is provisioned.

string | null

Registration type recorded against the user when a new account is provisioned.

string | null

Platform recorded against the user when a new account is provisioned.

string | null
enum

Version of the access token to issue. Matched case-insensitively; any other value falls back to the default version.

Allowed:
string | null

Preferred language recorded against the user.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json