Page History

Versions Compared

Key

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

...

RequiredNameTypeDescription
No

addLoginEmailsstring A comma-separated list of emails that should be added to the user's  login identifiers  list, and can be used for login purposes.
No
callbackfunction
Include Page
Template_gs api callback description
Template_gs api callback description
No
cidstring
Include Page
Template_gs api cid description
Template_gs api cid description

Include Page
Template_gs override params short note
Template_gs override params short note
No
conflictHandlingstringHow the server handles a "login identifier exists" conflict on a new account:
  • fail - (default) returns a "login identifier exists" error.
  • saveProfileAndFail - profile data is saved before returning error "OK with error login identifier exists".
No
contextobject
Include Page
Template_gs api context description
Template_gs api context description
No
dataJSON objectAn object containing custom data. Any data that you want to store regarding the user which isn't part of the profile object can be stored here.

Note that when using this parameter for users that already have custom data stored, it is not necessary to set all the fields again. Just include the fields you want to change or add. For example, the following code adds a "car" field to the user's custom data with the value "Suzuki Alto", or, if a "car" field already exists, its value is changed to "Suzuki Alto". Any other fields in the custom data objects remain unchanged.

Code Block
languagenone
linenumberstrue
gigya.accounts.setAccountInfo( {data: {car: "Suzuki Alto"}} );
No
muteWebhooksBoolean

When set to true, no webhooks are triggered by the API call. The default value is false.

No
newPasswordstringThe new password to replace the old one. Use this parameter with  password. When passing the securityQuestion or securityAnswer parameters the password parameter is required.
No
passwordstringThe old password to be changed. Use this parameter with newPassword.
No
profileProfile objectThe user's profile information as described in the Profile object. You may add to the predefined Gigya fields your own custom profile fields.
No
rbaJSON object

Sets the specified user's rba policy. Available properties include: 

  • riskPolicy - (string) Determines the rule set from the defined rulesSets configured in the site's RBA Policy or one of the default policies.

Warning

If accounts.rba.setPolicy.allowOverride is set to no, this will return an error. You can delete a previously set override by setting the accounts.rba.setPolicy RESTallowOverride value to null.

Code example to set a policy:

Code Block
rba: {
    "riskPolicy": "low"
}

Code example to remove the policy:

Code Block
rba: {
    "riskPolicy": null
}

For setting a site's RBA Policy, see Risk Based Authentication - RBA.

No
removeLoginEmailsstringA comma-separated list of emails to be removed from the user's login identifiers list.
No
requirePasswordChangeBooleanWhen set to true the server will require a password change on the next login.
No
secretAnswerstringA secret answer to the secret question that can be used for verification. Use this parameter with  secretQuestion Changing the secret answer will not work without providing the existing password ( password  parameter).
No
secretQuestionstringA secret question that can be used for verification. Use this parameter with secretAnswer Changing the secret question will not work without providing the existing password (password parameter).
No
usernamestringThe user's new username that can be used as a login identifier, if the site's Login Identifier Policy allow that.
Deprec
oldPasswordBooleanDeprecated . Use the password parameter instead.

...