# List of all Users in a client environment

Endpoint: GET /support/client-users
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Support Database

  - `target-vbasoftware-client-id` (string, required)
    Target Client ID

  - `target-vbasoftware-client-code` (string, required)
    Target Client Code

  - `target-vbasoftware-database` (string, required)
    Target Client Database

## Response 200 fields (text/plain):

  - `data` (array,null)

  - `data.user_ID` (string, required)
    User ID of the selected User.

  - `data.account_Locked` (boolean, required)
    This option will lock the account out of the application. To unlock the account, uncheck the box. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.address` (string,null)
    Address of the selected User.

  - `data.address2` (string,null)
    Address line 2 of the selected User.

  - `data.administrator` (boolean, required)
    Grants the User administrative rights. No security area needs to be assigned. This User will have full rights to every aspect of the application. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.audit_User` (boolean, required)
    This option enables logging based on the definitions provided within ‘User Log Message’. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.can_Set_Allowed` (string,null)
    If this option is selected, the User can override the ‘Allowed’ amount on the ‘Claim’ screen. This option applies to Users who are not flagged as an Administrator but have ‘View Access’ to the ‘Claim’ screen.

  - `data.can_Set_Co_Ins` (string,null)
    If this option is selected, the User can override the ‘Co-Ins’ amount on the ‘Claim’ screen. This option applies to Users who are not flagged as an Administrator but have ‘View Access’ to the ‘Claim’ screen.

  - `data.can_Set_Not_Covered` (string,null)
    If this option is selected, the User can override the ‘Not Covered’ amount on the ‘Claim’ screen. This option applies to Users who are not flagged as an Administrator but have ‘View Access’ to the ‘Claim’ screen.

  - `data.city` (string,null)
    City of the selected User's address.

  - `data.claim_Maximum` (number,null)
    When an adjudicated claim’s ‘Payable Amount’ exceeds this number, the ‘User Claim Max Exceeded’ Ex Code will be applied to the claim.

  - `data.country_ID` (string,null)
    ID of the country of the User's address.

  - `data.eMail_Address` (string, required)
    Email address of the User.

  - `data.entry_Date` (string)
    Date record was first added to the system

  - `data.entry_User` (string,null)
    User that first added the record to the system

  - `data.fax` (string,null)
    Fax number of the User.

  - `data.fax_Country_Code` (string,null)
    Country code of the User's fax number.

  - `data.grace_Logins` (integer,null)
    Identifies the number of login attempts that are allowed before the User's account is locked.

  - `data.home_Phone` (string,null)
    Home phone number of the User.

  - `data.home_Phone_Country_Code` (string,null)
    Country code of the User's home phone number.

  - `data.iD_Card_Notification` (boolean, required)
    This option is informational only but can be used with a custom report. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.is_SSO_User` (boolean, required)
    Notes that this user is utilizing SSO to authenticate and login. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.login_Machine` (string,null)
    Identifies the machine on which the User is logged in.

  - `data.login_Sound` (string,null)
    No Longer In Use

  - `data.login_Status` (integer,null)
    Identifies the login status of the associated User.

  - `data.mfA_Device_Name` (string,null)
    The device name for the authenticator being utilzied by this user.

  - `data.mfA_Enabled` (boolean, required)
    Identifies that this user has enabled MFA (Multi-Factor Authentication) and a code is required to login. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.name` (string,null)
    Name of the selected User.

  - `data.nav_ID_Color` (integer,null)
    Identifies the color that will be used for navigation fields.

  - `data.nav_ID_Type` (string,null)
    The nav. (navigation) fields are related to the functionality within VBA that allows a User to use hyperlinks to move between screens/service areas. The fields will appear blank on the ‘User System Options’ area, but the system is setup with the default functionality that is recommended by VBA.

  - `data.nav_ID_Underline` (boolean, required)
    When the box is checked, the field hyperlinks within VBA will appear underlined. When the box is unchecked, the hyperlinks will still function but will not be underlined. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.password` (string,null)
    Password of the selected User. Password requirements are set within the 'Application Settings' found from 'System Services' > 'VBA Control Panel'.

  - `data.password_Expiration` (string,null)
    Date when the User's password will expire.

  - `data.phone` (string,null)
    Phone number of the User.

  - `data.phone_Country_Code` (string,null)
    Country code of the User's phone number.

  - `data.ssO_User_Name` (string,null)
    The SSO user name to be used during the Single Sign-On process.

  - `data.single_Use_Account` (boolean, required)
    This option indicates that only one application can be opened using this login ID. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.state` (string,null)
    State of the selected User's address.

  - `data.title` (string,null)
    Title of the selected User.

  - `data.update_Date` (string)
    Date the record was last updated in the system

  - `data.update_User` (string,null)
    User that last updated the record in the system

  - `data.use_Windows_Authentication` (boolean, required)
    Whether or not to use Windows Authentication to login Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.user_Idle` (integer,null)
    Identifies the idle time, in seconds, before the application closes.

  - `data.user_Type` (string,null)
    Identifies the type associated with the User.

  - `data.vbA_Password_Reset` (boolean, required)
    This flag indicates that this user can change other VBA_User's passwords. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.vbA_User` (boolean, required)
    Identifies that the User is a VBA User. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.zip_Code` (string,null)
    Zip code of the selected User's address.

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields