updateWebUser request

updateWebUser request fields

To update web user account information, pass the following fields:

Name Type Required Description
active Boolean (error)
  • Set to true to activate an account.
  • Set to false to make the account inactive.
addMerchantCodes

List

(error)
A list holding merchant codes you want to activate and associate with the specified user account.

A merchant code string holds a value to identify a merchant.

Format:

  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code

Merchant codes in this list should not be included in deleteMerchantCodes as well.

deleteMerchantCodes

List

(error)
A list holding merchant codes you want to make inactive and remove from the specified user account.

 

A merchant code string holds a value to identify a merchant.

Format:

  • Either: MerchantAccount.Merchant_Code
  • Or: Merchant_Code

Merchant codes in this list should not be included in addMerchantCodes as well.

email String (error)
The email address associated with the user account.
grantRoles List (error)
Unable to render {include} The included page could not be found.
new roles you want to assign to the specified user account.
  • RoleType

Roles in this list should not be included in revokeRoles as well.

RoleType enum (error)
It defines the type of role assigned to the user account.
Allowed values:
  • Merchant_manage_payments
  • Merchant_Report_role
  • Merchant_dispute_management
  • Merchant_technical_integrator
  • Merchant_View_Risk_Results_role
  • Merchant_view_risk_settings
  • Merchant_change_risk_settings 
  • Merchant_allowed_own_password_reset 
name class (error)
A container object for personal data
  • firstName
  • gender
  • infix
  • lastName
firstName String (error)
The first name/given name of the user.
  • Max. length: 80 characters
gender enum (error)
Defines the gender of the user.
Allowed values:
  • MALE
  • FEMALE
  • UNKNOWN
infix String (error)
Infix in the user account's name.
  • Max. length: 20 characters
lastName String (error)
The last name/family name of the user.
  • Max. length: 80 characters
revokeRoles List (error)
Unable to render {include} The included page could not be found.
assigned roles you want to revoke from the specified user account.
  • RoleType

Roles in this list should not be included in grantRoles as well.

RoleType enum (error)
It defines the type of role assigned to the user account.
Allowed values:
  • Merchant_manage_payments
  • Merchant_Report_role
  • Merchant_dispute_management
  • Merchant_technical_integrator
  • Merchant_View_Risk_Results_role
  • Merchant_view_risk_settings
  • Merchant_change_risk_settings 
  • Merchant_allowed_own_password_reset 
timeZoneCode String (error)
The time zone associated to the user account profile.

If you do not specify any value, the active user's time zone settings are used instead.

userName String (tick)
A user name string holds the user account display name.
It can include:
  • Digits: 0-9
  • Letters a-z, A-Z
  • Special characters: "." (dot), "-" (hyphen), "_" (underscore)