{"title":"Add a web user","category":"default","creationDate":1776961629,"content":"

Use the \/addWebUser<\/code> endpoint to create a new web user associated with one or more merchant accounts. If the request does not include any merchant codes, the web user is created, but not activated.<\/p>\n

Request parameters<\/h2>\n

To create a new web user, make a POST \/addWebUser<\/code> specifying:<\/p>\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Name<\/th>\n Type<\/th>\n
Required<\/center><\/th>\n
Description<\/th>\n <\/tr>\n
email<\/code><\/td>\n \n

String<\/p>\n<\/td>\n

\n
\"-white_check_mark-\"<\/center>\n<\/td>\n
\n

The email address associated with the user account.<\/p>\n<\/td>\n <\/tr>\n

merchantCodes<\/code><\/td>\n \n

Array<\/p>\n<\/td>\n

\n
\"-x-\"<\/center>\n<\/td>\n
\n

An array of merchant code strings.
A merchant code string holds a value to identify a merchant.<\/p>\n

Format:<\/p>\n

    \n
  • Either: MerchantAccount.Merchant_Code<\/code><\/li>\n
  • Or: Merchant_Code<\/code><\/li>\n<\/ul>\n<\/td>\n <\/tr>\n
accountGroupCodes<\/code><\/td>\n \n

Array<\/p>\n<\/td>\n

\n
\"-x-\"<\/center>\n<\/td>\n
\n

An array of account group names<\/a>.
\nFor example: [\"groupEU\", \"groupUS\"]<\/code>.<\/p>\n<\/td>\n <\/tr>\n

timeZoneCode<\/code><\/td>\n \n

String<\/p>\n<\/td>\n

\n
\"-white_check_mark-\"<\/center>\n<\/td>\n
\n

The time zone associated to the user account profile.<\/p>\n

If you do not specify any value, the active user's time zone settings are used instead.<\/p>\n<\/td>\n <\/tr>\n

userName<\/code><\/td>\n \n

String<\/p>\n<\/td>\n

\n
\"-white_check_mark-\"<\/center>\n<\/td>\n
\n

A user name string holds the user account display name.
\nIt can include:<\/p>\n

    \n
  • Digits: 0-9<\/em><\/li>\n
  • Letters a-z<\/em>, A-Z<\/em><\/li>\n
  • Special characters: \".<\/em>\" (dot), \"-<\/em>\" (hyphen), \"_<\/em>\" (underscore)
    \n<\/em><\/li>\n<\/ul>\n<\/td>\n <\/tr>\n
name<\/code><\/td>\n \n

Object<\/p>\n<\/td>\n

\n
\"-white_check_mark-\"<\/center>\n<\/td>\n
\n

A container object for personal data. This object contains:

  • firstName<\/code><\/li>
  • lastName<\/code><\/li><\/ul><\/p>\n<\/td>\n <\/tr>\n
<\/td>\n |-firstName<\/code><\/td>\n \n

String<\/p>\n<\/td>\n

\n
\"-white_check_mark-\"<\/center>\n<\/td>\n
\n

The first name\/given name of the user.<\/p>\n

    \n
  • Max. length: 80 characters<\/li>\n<\/ul>\n<\/td>\n <\/tr>\n
\u00a0<\/td>\n |-lastName<\/code><\/td>\n \n

String<\/p>\n<\/td>\n

\n
\"-white_check_mark-\"<\/center>\n<\/td>\n
\n

The last name\/family name of the user.<\/p>\n

    \n
  • Max. length: 80 characters<\/li>\n<\/ul>\n<\/td>\n <\/tr>\n
roles<\/code><\/td>\n \n

Array<\/p>\n<\/td>\n

\n
\"-x-\"<\/center>\n<\/td>\n
\n

A container object for\u00a0types of role for the account user.<\/p>\n

    \n
  • RoleType<\/code><\/li>\n<\/ul>\n<\/td>\n <\/tr>\n
<\/td>\n RoleType<\/code><\/td>\n \n

Enum<\/p>\n<\/td>\n

\n
\"-x-\"<\/center>\n<\/td>\n
\n

It defines the type of role assigned to the user account.
\nSome examples of roles are:<\/p>\n

    \n
  • Merchant_standard_role<\/code><\/li>\n
  • Merchant_manage_payments<\/code><\/li>\n
  • Merchant_Report_role<\/code><\/li>\n
  • Merchant_dispute_management<\/code><\/li>\n
  • Merchant_technical_integrator<\/code><\/li>\n
  • Merchant_View_Risk_Results_role<\/code><\/li>\n
  • Merchant_view_risk_settings<\/code><\/li>\n
  • Merchant_change_risk_settings<\/code>\u00a0<\/li>\n
  • Merchant_allowed_own_password_reset<\/code><\/li>\n<\/ul>\n<\/td>\n <\/tr>\n <\/tbody>\n<\/table>\n

    Response parameters<\/h2>\n

    If there are no errors in the request, the call returns user name and password for the newly created user account, and a pspReference<\/code>.<\/p>\n

    If any issues occur during the process, the call returns one or more warning or error messages. In this case, no user name and no password data is included in the response.<\/p>\n
    Name<\/th>Type<\/th>Returned by default<\/th>Description<\/th><\/tr><\/thead>
    \n

    userName<\/code><\/p>\n<\/td>

    		\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    The user name assigned to the newly created account.<\/p>\n<\/td><\/tr>

    \n

    password<\/code><\/p>\n<\/td>

    		\n

    String<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		The password assigned to the newly created account.
    \nThis is a temporary, one-time password.
    \nUsers need to define a new one upon their first successful login.<\/td><\/tr>
    \n

    pspReference<\/code><\/p>\n<\/td>

    		\n

    String<\/p>\n<\/td>

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\n

    A reference to uniquely identify the request.<\/p>\n<\/td><\/tr>

    \n

    warnings<\/code><\/p>\n<\/td>

    		\n

    Array<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    List containing one or more warning messages.
    \nReturned when the request is not correctly processed.<\/p>\n<\/td><\/tr>

    \n

    errors<\/code><\/p>\n<\/td>

    		\n

    Array<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\n

    List containing one or more error messages.
    \nReturned when the request fails.<\/p>\n<\/td><\/tr><\/tbody><\/table>\n

    Examples<\/h2>\n

    Request<\/h3>\n
    \n <\/code-sample>\n<\/div>\n

    Response<\/h3>\n
    \n <\/code-sample>\n<\/div>\n

    Response in case of an error<\/h3>\n
    \n <\/code-sample>\n<\/div>","url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-user-accounts\/addwebuser","articleFields":{"description":"Create a new web user for one or more merchant accounts.","id":"25134999","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"11-12-2019 14:33"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-user-accounts\/addwebuser","title":"Add a web user","content":"Use the \/addWebUser endpoint to create a new web user associated with one or more merchant accounts. If the request does not include any merchant codes, the web user is created, but not activated.\nRequest parameters\nTo create a new web user, make a POST \/addWebUser specifying:\n\n\n \n \n Name\n Type\n Required\n Description\n \n \n email\n \nString\n\n \n\n\n \nThe email address associated with the user account.\n\n \n \n merchantCodes\n \nArray\n\n \n\n\n \nAn array of merchant code strings.A merchant code string holds a value to identify a merchant.\nFormat:\n\nEither: MerchantAccount.Merchant_Code\nOr: Merchant_Code\n\n\n \n \n accountGroupCodes\n \nArray\n\n \n\n\n \nAn array of account group names.\nFor example: [\"groupEU\", \"groupUS\"].\n\n \n \n timeZoneCode\n \nString\n\n \n\n\n \nThe time zone associated to the user account profile.\nIf you do not specify any value, the active user's time zone settings are used instead.\n\n \n \n userName\n \nString\n\n \n\n\n \nA user name string holds the user account display name.\nIt can include:\n\nDigits: 0-9\nLetters a-z, A-Z\nSpecial characters: \".\" (dot), \"-\" (hyphen), \"_\" (underscore)\n\n\n\n \n \n name\n \nObject\n\n \n\n\n \nA container object for personal data. This object contains: firstNamelastName\n\n \n \n \n |-firstName\n \nString\n\n \n\n\n \nThe first name\/given name of the user.\n\nMax. length: 80 characters\n\n\n \n \n \u00a0\n |-lastName\n \nString\n\n \n\n\n \nThe last name\/family name of the user.\n\nMax. length: 80 characters\n\n\n \n \n roles\n \nArray\n\n \n\n\n \nA container object for\u00a0types of role for the account user.\n\nRoleType\n\n\n \n \n \n RoleType\n \nEnum\n\n \n\n\n \nIt defines the type of role assigned to the user account.\nSome examples of roles are:\n\nMerchant_standard_role\nMerchant_manage_payments\nMerchant_Report_role\nMerchant_dispute_management\nMerchant_technical_integrator\nMerchant_View_Risk_Results_role\nMerchant_view_risk_settings\nMerchant_change_risk_settings\u00a0\nMerchant_allowed_own_password_reset\n\n\n \n \n\nResponse parameters\nIf there are no errors in the request, the call returns user name and password for the newly created user account, and a pspReference.\nIf any issues occur during the process, the call returns one or more warning or error messages. In this case, no user name and no password data is included in the response.\nNameTypeReturned by defaultDescription\nuserName\n\nString\n\n\n\nThe user name assigned to the newly created account.\n\npassword\n\nString\n\n\nThe password assigned to the newly created account.\nThis is a temporary, one-time password.\nUsers need to define a new one upon their first successful login.\npspReference\n\nString\n\n\n\nA reference to uniquely identify the request.\n\nwarnings\n\nArray\n\n\n\nList containing one or more warning messages.\nReturned when the request is not correctly processed.\n\nerrors\n\nArray\n\n\n\nList containing one or more error messages.\nReturned when the request fails.\n\nExamples\nRequest\n\n \n\nResponse\n\n \n\nResponse in case of an error\n\n \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Account management API","lvl2":"Manage user accounts","lvl3":"Add a web user"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/account-management-api","lvl2":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-user-accounts","lvl3":"\/pt\/account-management-api\/manage-user-accounts\/addwebuser"},"levels":4,"category":"","category_color":"","tags":[]},"articleFiles":{"309476445.json":"

    309476445.json<\/p>","1245825773.json":"

    1245825773.json<\/p>","2001170383.json":"

    2001170383.json<\/p>"}}