This method may only be used if you are implementing Gigya's REST API in compliance with OAuth 2.0.
This API serves as an end point for connecting the user to a specified* social network. This API requires user interaction. To add a connection, redirect the user to the specified URL and pass the required parameters. When the addConnection process completes - either successfully or with an error - the Gigya server redirects the user to the URL defined in the redirect_uri parameter and appends response parameters.
Technically speaking, a connection is an established session with the social network and it expires according to the social network policy. A valid and active connection will give your site access to the user's social graph and ability to perform various social actions, such as publishing a newsfeed report to the connected social network.
* The social network to connect to is specified using the "provider" required parameter. You may find more details in the parameter description below.
This operation currently supported by the following providers:
us1.gigya.com- For the US data center.
eu1- For the European data center.
au1- For the Australian data center.
ru1- For the Russian data center.
cn1- For the Chinese data center.
If you are not sure of your site's data center, see Finding Your Data Center.
|||oauth_token||string||The OAuth access token for the user. Read more in The OAuth 2.0 protocol. This must be passed over HTTPS; requests made over non-SSL connections will return an error invalid_token (errorCode 403025).|
|||x_provider||string||The provider to connect to. The optional values for this parameter are: 'facebook', googleplus, 'twitter', 'yahoo', 'microsoft', 'line', 'linkedin', 'qq', 'renren', 'sina' , vkontakte , wechat (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used), 'googleplus', 'instagram', 'renren','vkontakte', 'mixi', 'odnoklassniki', 'yahoojapan' and 'wechat'. Also SAML providers are supported - the format of the provider name is "saml-".|
|||redirect_uri||URL||The URL to redirect to after the addConnection completes. The URL must be verified against the registered domain for this API key.|
|||response_type||string||May be either "code" or "token"|
|||state||string||A string that will be passed as another parameter to the redirect_uri after the login completes.|
|||x_lang||string||Defines the language of Gigya's user interface and error message. For the list of languages supported, please refer to the languages table.|
|||x_extraPermissions||string||A comma-delimited list of extended permissions to request from the user. This parameter gives the possibility to request extended permissions in addition to the permissions that Gigya is already requesting. Refer to Facebook's extended permissions page for the complete list of Facebook permissions.|
For example, if you wish to RSVP to events on the user's behalf and to send sms messages to the user, define: x_extraPermissions="rsvp_event,sms". To request Google wallet permissions define: x_extraPermissions="wallet".
|||x_displayMode||string||The display mode of of the Facebook login page. The valid values are:|
|state||string||The state string passed by your application as parameter to the login endpoint. (See Parameters above).|
A field that does not contain data will not appear in the response.