Central Auth APIDefault

Link Social Account

Link a social account to the user

Authentication

AuthorizationBearer
Bearer token authentication

Request

This endpoint expects an object.
providerstringRequired
callbackURLstring or nullOptional
The URL to redirect to after the user has signed in
idTokenobject or nullOptional
requestSignUpboolean or nullOptional
scopeslist of any or nullOptional
Additional scopes to request from the provider
errorCallbackURLstring or nullOptional
The URL to redirect to if there is an error during the link process
disableRedirectboolean or nullOptional
Disable automatic redirection to the provider. Useful for handling the redirection yourself
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
redirectboolean
Indicates if the user should be redirected to the authorization URL
urlstring
The authorization URL to redirect the user to
statusboolean

Errors

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