Page History

Versions Compared

Key

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

...

RequiredNameTypeDescription
Varies

UID*string

The unique ID of the user for which to set account data. Use either this parameter or regToken.

* You are required to pass only one of the parameters either UID or regToken.

Varies
regToken**string

The regToken  returned from accounts.initRegistrationaccounts.register or accounts.login API calls when the registration process has not been finalized. Please note that the regToken  you receive from Gigya is valid for only one hour. Calls passing a regToken are handled as client-side calls by the server: fields with a writeAccess permission of "server only" will be inaccessible. 

** When passing regToken, the call must be made over HTTPS.

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
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
dataJSON object

Anchor
dataObject
dataObject

An 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
languagejs
linenumberstrue
{'car':'Suzuki Alto'}
No
isActiveBooleanThis parameter allows disabling the account. This is only permitted when calling this method from server-side, attempting to disable an account from a client SDK will return an error.
Deprec
isLockedOutBooleanThis parameter has been deprecated. Use accounts.rba.unlock REST instead.
No
isVerifiedBoolean Indicates whether the account email(s) are verified.
If you pass the value 'true', all unverified email addresses in the account will be flagged as verified.
No
muteWebhooksBooleanWhen 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.
Note: If this parameter is passed then the method must be called using HTTPS.
No
passwordstringThe old password to be changed. Use this parameter with  newPassword .
Note: If this parameter is passed then the method must be called using HTTPS.
No
profileProfile objectThe user's profile information as described in the Profile object. You may add data to the predefined Gigya fields. To add your own custom profile fields, use the data object.
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
securityOverrideBooleanThe default value is "false". When set to "true", the API call does not require the oldPassword for setting the newPassword. It also does not require a password validation when setting the secret question and answer for the first time. Only users with _sites permissions are allowed to pass this parameter. Read more about Console Administration.
No
rbaJSON object

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

  • riskPolicy - Determines the rule set from the defined rulesSets configured in accounts.rba.setPolicy or one of the default policies.
  • riskPolicyLocked - Determines whether the user can change their own riskPolicy. If true, only an admin can change the user's riskPolicy.

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 REST allowOverride value to null.

Code example:

Code Block
rba: {
      "riskPolicy": "low",
      "riskPolicyLocked": true
}

For setting a site's RBA Policy, see Accounts RBA Policy Object.

No
usernamestringThe user's new username that can be used as a login identifier, if the site's Login Identifier Policy allow that.
No
createddateThe time the account was created in ISO 8601 format, e.g. "2014-07-16T19:20:30Z".
No
regSourcestringA string representing the source of the registration. Can be used to set varying destination pages in accounts.setPolicies.
Include Page
Template_gs REST api common optional parameters new
Template_gs REST api common optional parameters new
Deprec
oldPasswordBooleanDeprecated . Use the password parameter instead.

...