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

Request parameters<\/h2>\n

To get detailed web user account information, make a POST \/getWebUser<\/code> request specifying<\/p>\n<\/colgroup>
Name<\/th>Type<\/th>Required<\/th>Description<\/th><\/tr><\/thead>

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

\n

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

\n
\"-white_check_mark-\"<\/center>\n<\/td>
\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><\/tr><\/tbody><\/table>\n

    Response parameters<\/h2>\n

    If there are no errors in the request, the call returns\u00a0detailed information about the specified user account.<\/p>\n

    If any issues occur during the process, the call returns an error message.<\/p>\n\n\n \n \n \n \n \n \n
    Name<\/th>\n Type<\/th>\n Returned\u00a0by\u00a0default<\/th>\n Description<\/th>\n <\/tr>\n
    pspReference<\/code><\/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>

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

    		\n

    Boolean<\/p>\n<\/td>

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

      true<\/code>: the account is active.<\/p>\n<\/li>

    • \n

      false<\/code>: the account is inactive.<\/p>\n<\/li><\/ul>\n<\/td><\/tr>

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

    		\n

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

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

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

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

    List<\/p>\n<\/td>

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

    A list holding 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><\/tr>\n
    accountGroupCodes<\/code><\/td>\n \n

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

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

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

    roles<\/code>
    \n<\/td>    		\n

    List<\/p>\n<\/td>

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

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

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

    enum<\/p>\n<\/td>

    		\n
    \"-x-\"<\/center>\n<\/td>
    		\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><\/tr>

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

    		\n

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

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\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><\/tr>

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

    		\n

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

    		\n
    \"-white_check_mark-\"<\/center>\n<\/td>
    		\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><\/tr>\n
    name<\/code><\/td>\n \n

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

    		\n
    \"-x-\"<\/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
    \"-x-\"<\/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
    \"-x-\"<\/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<\/tbody><\/table>\n

      Examples<\/h2>\n

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

      Response<\/h3>\n
      \n <\/code-sample>\n<\/div>","url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-user-accounts\/getwebuser","articleFields":{"id":"25135011","type":"page","description":"Get user account information.","_expandable":{"operations":""},"status":"current"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/account-management-api\/manage-user-accounts\/getwebuser","title":"Get a web user","content":"Request parameters\nTo get detailed web user account information, make a POST \/getWebUser request specifying\nNameTypeRequiredDescriptionuserName\n\nString\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\nResponse parameters\nIf there are no errors in the request, the call returns\u00a0detailed information about the specified user account.\nIf any issues occur during the process, the call returns an error message.\n\n\n \n \n Name\n Type\n Returned\u00a0by\u00a0default\n Description\n \n pspReference\nString\n\n\n\nA reference to uniquely identify the request.\nactive\n\nBoolean\n\n\n\n\ntrue: the account is active.\n\nfalse: the account is inactive.\n\nemail\n\nString\n\n\n\nThe email address associated with the user account.\nmerchantCodes\n\nList\n\n\n\nA list holding 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 accountGroupCodes\n \nArray\n\n \n\n\n \nAn array of account group names.\nFor example: [\"groupEU\", \"groupUS\"].\n\n\nroles\n\nList\n\n\n\nA container object for\u00a0types of role for the account user.\n\nRoleType\n\nRoleType\nenum\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\ntimeZoneCode\n\nString\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.\nuserName\n\nString\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 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\nExamples\nRequest\n\n \n\nResponse\n\n \n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Account management API","lvl2":"Manage user accounts","lvl3":"Get 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\/getwebuser"},"levels":4,"category":"","category_color":"","tags":[]},"articleFiles":{"41260873.json":"

      41260873.json<\/p>","1837377655.json":"

      1837377655.json<\/p>"}}