Page History

Versions Compared

Key

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

...

RequiredNameTypeDescription
Varies
usernamestringA string that the user enters to identify his account.*
Varies
email stringThe user's email address.*
 *  You are required to pass either username or email , depending on the specification of the site's Login Identifier policy.
Yes
passwordstringThe user's password. Gigya validates that the password meets the complexity requirements defined in the site's Password Strength policy.
Yes
regTokenstring

The regToken that was returned by accounts.initRegistration  or the regToken  returned by accounts.login if the user tried to login before the registration process is finalized.

The regToken expires one hour after it is produced.

No
profileProfile objectThe user's profile information. The object may include site's custom fields in addition to reserved field names (as defined in the Profile object). Fields that are defined as required in the Schema , are required by this method. If not passed, the method will return a "pending registration" error and a new regToken
No
captchaTextstringThe CAPTCHA text typed by the user . This parameter is required if specified so in the site's  CAPTCHA policy .
No
captchaTokenstringThe CAPTCHA challenge. This parameter is required if specified so in the site's  CAPTCHA policy.
No
cidstringA string of maximum 100 characters length. The CID sets categories for transactions that can be used later for filtering reports generated by Gigya in the "Context ID" combo box. The CID allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. You should not define more than 100 different context IDs.
No
dataJSON objectCustom data. The purpose of this object is storing any custom data associated to the user, but which is not part of the Profile object. Gigya validates that the data fields meet the requirements that are defined in the Schema.
No
finalizeRegistrationBooleanIf set to 'true', this API call will also finalize the registration process for the user, and the user will appear as a 'New registered user' in the user reports.
If there are missing fields, the registration will remain pending. The default value is 'false'. 
No
secretQuestionstringThe secret question that can be used for verification. This parameter is required if specified so in the site's requireSecurityQuestion Policy.
No
secretAnswerstringThe answer to the secret question. This parameter is required if specified so in the site's requireSecurityQuestion Policy .
No
langstringThe language to use in error messages and validation emails. See also Email Templates. The language specified here is stored in the locale field of the site identity. If in the emailVerification policy the emailTemplates include a template in the specified language, the verification email sent to the user will be in this language. The same goes for the passwordReset policy.
No
targetEnvstring

This parameter defines your client side environment, which in return determines the server response data fields. The default value of this parameter is "browser", which means that by default you receive cookie-related data in the response. 

If your client runs on a mobile:

If you are calling this method using a Mobile SDK since version 2.15.6, this parameter is automatically set to "mobile" (there is no need to set it manually). In any other case, you should set this parameter to be "mobile". 

As a result of setting the parameter to "mobile" the server response data fields will include: sessionToken and sessionSecret (instead of cookie related data). In such case, you should send the sessionToken and sessionSecret to your mobile client. On your client side, call GSAPI.setSession (using the Mobile SDK) to save them in the app's storage.

No
includestringA comma-separated list of fields to include in the response. The possible values are:  identities-active, identities-allloginIDsemailsprofiledata, password, lastLoginLocation and irank. The default is profile and data, so if this parameter is not used the response will return the Profile and data objects.
No
sessionExpirationintegerThis parameter defines the time in seconds that Gigya should keep the login session valid for the user. To end the session when the browser closes, please assign the value '0'. If this parameter is not specified, the session is valid forever.
Note: The value of this parameter overrides the value of the identical parameter in the global configuration objectthe Global Configuration.
No
siteUIDstringYou may specify the UID to use with this account; if not specified,  it is auto-generated.
Note: The parameter accepts up to 252 ASCII characters (unicode is not supported).
No
regSourcestring
Include Page
parameter regSource
parameter regSource
Include Page
Template_gs REST api common optional parameters new
Template_gs REST api common optional parameters new

...