Gigya Job Openings

Page History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

RequiredNameTypeDescription
Yes
grant_type stringclient_credentials
No
x_siteUIDstring

You may provide the UID of the user that has been logged in by your site. This will generate an access token associated with the user and will allow you to invoke REST API methods, without passing the UID parameter.

When passing this parameter, this method becomes equivalent to the socialize.notifyLogin API method, notifying the Gigya service that the user has been logged-in by the site. Note that any providerSessions parameter will be ignored and if a user is not yet logged in, this will not automatically log the user in.

No
x_userInfoJSON string

This parameter is relevant only if the x_siteUID parameter (see above) is specified.
This parameter allows you to provide Gigya with site's user profile data. This will ensure consistent user experience. Gigya will use this information, for example, in Plugins that show user info, such as the Chat and the Comments Plugins.
The object may include the following fields: nickname, photoURL, thumbnailURL, firstName, lastName, gender, age, email.
For example:

Code Block
languagenone
linenumberstrue
x_siteUID=12345&userInfo;={firstName:"David", gender:"male", age:30}
No
x_sessionExpirationintegerThe time in seconds that Gigya should keep the session valid for the user. To end the session when the browser closes, assign the value '0'. If this parameter is not specified, the session will be valid forever.
No
regSourcestring
Include Page
parameter regSource
parameter regSource

...

RequiredNameTypeDescription
Yes
grant_type stringnone
No
x_siteUIDstring

You may provide the UID of the user that has been logged in by your site. This will generate an access token associated with the user and will allow you to invoke REST API methods, without passing the UID parameter.

When passing this parameter, this method becomes equivalent to the socialize.notifyLogin API method, notifying the Gigya service that the user has been logged-in by the site. Note that any providerSessions parameter will be ignored and if a user is not yet logged in, this will not automatically log the user in.

No
x_userInfoJSON string

This parameter is relevant only if the x_siteUID parameter (see above) is specified.
This parameter allows you to provide Gigya with site's user profile data. This will ensure consistent user experience. Gigya will use this information, for example, in Plugins that show user info, such as the Chat and the Comments Plugins.
The object may include the following fields: nickname, photoURL, thumbnailURL, firstName, lastName, gender, age, email.
For example:

Code Block
languagenone
linenumberstrue
x_siteUID=12345&userInfo;={firstName:"David", gender:"male", age:30}
No
x_sessionExpirationintegerThe time in seconds that Gigya should keep the session valid for the user. To end the session when the browser closes, assign the value '0'. If this parameter is not specified, the session will be valid forever.
No
regSourcestring
Include Page
parameter regSource
parameter regSource