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

Use the \/inviteWebUser<\/code> endpoint to create a user and send an email to invite them to register.<\/p>\n

After you submit the request, the user will receive an email from Adyen, containing a one-time use link to a page where they create their own password to complete the registration process. The link is valid within 24 hours. If the link has already expired and the user has not yet completed the registration, inform them to contact their Admin and ask to send a new invitation email.<\/p>\n

The endpoint requires at least one merchantCode<\/code> and one role<\/code>. After the user completes the registration, their account will be associated with the merchant codes provided in the request.<\/p>\n

Request parameters<\/h2>\n

To invite a new web user, make a POST \/inviteWebUser<\/code> request specifying the following parameters:<\/p>\n\n\n \n <\/tbody>\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
\"-white_check_mark-\"<\/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
\"-white_check_mark-\"<\/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

    The response contains the user name and a pspReference<\/code>.<\/p>\n

    If any issues occur during the process, the call returns one or more warning or error messages. The user is not created and no username is returned in the response.<\/p>\n\n\n\n\n\n\n\n\n
    Name<\/th>\nType<\/th>\nReturned by default<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    userName<\/code><\/td>\nString<\/td>\n\"-x-\"<\/td>\nThe user name assigned to the newly created account.<\/td>\n<\/tr>\n
    pspReference<\/code><\/td>\nString<\/td>\n\"-white_check_mark-\"<\/td>\nUnique identifier for the request.<\/td>\n<\/tr>\n
    warnings<\/code><\/td>\nArray<\/td>\n\"-x-\"<\/td>\nString array containing one or more warning messages.
    Returned when the request is not correctly processed.<\/td>\n<\/tr>\n
    errors<\/code><\/td>\nArray<\/td>\n\"-x-\"<\/td>\nString array containing one or more warning messages.
    Returned when the request is not correctly processed.<\/td>\n<\/tr>\n<\/tbody>\n<\/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\/invite-web-users","articleFields":{"description":"Create a new web user and send a registration email.","id":"25134998","type":"page","_expandable":{"operations":""},"status":"current","last_edit_on":"13-12-2019 10:04"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-user-accounts\/invite-web-users","title":"Invite web user","content":"Use the \/inviteWebUser endpoint to create a user and send an email to invite them to register.\nAfter you submit the request, the user will receive an email from Adyen, containing a one-time use link to a page where they create their own password to complete the registration process. The link is valid within 24 hours. If the link has already expired and the user has not yet completed the registration, inform them to contact their Admin and ask to send a new invitation email.\nThe endpoint requires at least one merchantCode and one role. After the user completes the registration, their account will be associated with the merchant codes provided in the request.\nRequest parameters\nTo invite a new web user, make a POST \/inviteWebUser request specifying the following parameters:\n\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\nThe response contains the user name and a pspReference.\nIf any issues occur during the process, the call returns one or more warning or error messages. The user is not created and no username is returned in the response.\n\n\n\nName\nType\nReturned by default\nDescription\n\n\n\n\nuserName\nString\n\nThe user name assigned to the newly created account.\n\n\npspReference\nString\n\nUnique identifier for the request.\n\n\nwarnings\nArray\n\nString array containing one or more warning messages. Returned when the request is not correctly processed.\n\n\nerrors\nArray\n\nString array containing one or more warning messages. Returned when the request is not correctly processed.\n\n\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":"Invite 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\/invite-web-users"},"levels":4,"category":"","category_color":"","tags":["Invite"]},"articleFiles":{"309476445.json":"

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

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

    2001170383.json<\/p>"}}