Central Auth APIDefault

Social Sign In

Sign in with a social provider

Authentication

AuthorizationBearer
Bearer token authentication

Request

This endpoint expects an object.
providerstringRequired
callbackURLstring or nullOptional
Callback URL to redirect to after the user has signed in
newUserCallbackURLstring or nullOptional
errorCallbackURLstring or nullOptional
Callback URL to redirect to if an error happens
disableRedirectboolean or nullOptional
Disable automatic redirection to the provider. Useful for handling the redirection yourself
idTokenobject or nullOptional
scopeslist of any or nullOptional
Array of scopes to request from the provider. This will override the default scopes passed.
requestSignUpboolean or nullOptional

Explicitly request sign-up. Useful when disableImplicitSignUp is true for this provider

loginHintstring or nullOptional
The login hint to use for the authorization code request
additionalParamsmap from strings to strings or nullOptional

Extra query parameters to append to the provider authorization URL (e.g. Cognito identity_provider, Google hd).

additionalDatamap from strings to any or nullOptional

Response

Success - Returns session details (idToken branch) or an authorize URL (redirect branch)

redirectboolean
tokenstring
userobject
urlstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error