User

User Authentication

Starts User Authentication

SecurityapiKeyAuth and basicAuth
Request
header Parameters
vbasoftware-client-id
required
string

Client ID

vbasoftware-client-code
required
string

Client Code

vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

post/user-authentication
Request samples 
Response samples 
No sample
Refresh User Tokens
Uses the Refresh Token to obtain new JWT tokens to extend the user's session.


SecurityapiKeyAuth 
Request 
header Parameters
vbasoftware-client-id
required
string
Client ID


 
vbasoftware-client-code
required
string
Client Code


 
vbasoftware-database
required
string
Target database


 
expired-id-token
required
string
Expired Id Token


 
refresh-token
required
string
Refresh Token


 
Responses 
200
Success


401
Unauthorized


post/user-refresh-tokens
Request samples 
Response samples 
No sample
Change Temporary Password
Changes a User's temporary password.


SecurityapiKeyAuth 
Request 
header Parameters
vbasoftware-client-id
required
string
Client ID


 
vbasoftware-client-code
required
string
Client Code


 
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
userID
required
string  non-empty 
The User ID


 
newPassword
required
string  non-empty 
The User's new new password


 
session
required
string  non-empty 
The session token returned from the original login attempt that triggered the Change Temp Password flow.


 
Responses 
200
Success


401
Unauthorized


post/change-temporary-password
Request samples 
{
  • "userID": "string",
  • "newPassword": "string",
  • "session": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Forgot Password
Begin password recovery flow. Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password.


SecurityapiKeyAuth 
Request 
header Parameters
vbasoftware-client-id
required
string
Client ID


 
vbasoftware-client-code
required
string
Client Code


 
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
userID
string or null
The User ID


 
Responses 
200
Success


401
Unauthorized


post/forgot-password
Request samples 
{
  • "userID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Confirm Forgot Password
Allows a user to enter a confirmation code to reset a forgotten password.


SecurityapiKeyAuth 
Request 
header Parameters
vbasoftware-client-id
required
string
Client ID


 
vbasoftware-client-code
required
string
Client Code


 
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
userID
string or null
The User ID


 
password
string or null
The new password.


 
confirmationCode
string or null
The confirmation code received from the latest forgot password request.


 
Responses 
200
Success


401
Unauthorized


post/confirm-forgot-password
Request samples 
{
  • "userID": "string",
  • "password": "string",
  • "confirmationCode": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
User Change Password
User requests to change their password.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
accessToken
required
string  non-empty 
A valid access token that Amazon Cognito issued to the user whose password you want to change.


 
previousPassword
required
string  non-empty 
The old new password.


 
proposedPassword
required
string  non-empty 
The new password.


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/change-password
Request samples 
{
  • "accessToken": "string",
  • "previousPassword": "string",
  • "proposedPassword": "string"
}
Response samples 
{
  • "data": "string",
  • "error": {
    },
  • "debug": {
    }
}
Admin Reset User Password
Admin request to reset a User's password. When an Administrator calls this API, the User's current password is invalidated and must be changed. If a user tries to sign in after the API is called, the User will get a PasswordResetRequired message back and should use the forgot password flow. In addition, if a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/admin-reset-password
Request samples 
Response samples 
No sample
Admin Disable User
Admin request to disable a User.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/admin-disable
Request samples 
Response samples 
No sample
Admin Enable User
Admin request to enable a User.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/admin-enable
Request samples 
Response samples 
No sample
Admin Resend Confirmation Code
Resends a User a confirmation code.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/resend-confirmation-code
Request samples 
Response samples 
No sample
Admin Resend Welcome Message
Resends the invitation message to a user that already exists and resets the expiration on the user's sign-up window.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


post/users/{userID}/resend-welcome-message
Request samples 
Response samples 
No sample
Submit MFA Code
Submits a multi-factor authentication (MFA) code provided by the user and completes the authentication process.


SecurityapiKeyAuth 
Request 
header Parameters
vbasoftware-client-id
required
string
Client ID


 
vbasoftware-client-code
required
string
Client Code


 
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
username
required
string  non-empty 
The username of the user sending the multi-factor authentication code.


 
mfaCode
required
string  non-empty 
The multi-factor authentication code provided by the user.


 
session
required
string  non-empty 
The session that should be passed both ways in challenge-response calls to the service.


 
Responses 
202
Accepted


401
Unauthorized


post/mfa-submit-code
Request samples 
{
  • "username": "string",
  • "mfaCode": "string",
  • "session": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Create User
Creates a new User


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
user_ID
required
string  [ 1 .. 16 ] characters 
User ID of the selected User.


 
account_Locked
required
boolean
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.


 
address
string or null  <= 255 characters 
Address of the selected User.


 
address2
string or null  <= 128 characters 
Address line 2 of the selected User.


 
administrator
required
boolean
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.


 
audit_User
required
boolean
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.


 
can_Set_Allowed
string or null  <= 1 characters 
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.


 
can_Set_Co_Ins
string or null  <= 1 characters 
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.


 
can_Set_Not_Covered
string or null  <= 1 characters 
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.


 
city
string or null  <= 32 characters 
City of the selected User's address.


 
claim_Maximum
number or null <double> 
When an adjudicated claim’s ‘Payable Amount’ exceeds this number, the ‘User Claim Max Exceeded’ Ex Code will be applied to the claim.


 
country_ID
string or null  <= 8 characters 
ID of the country of the User's address.


 
eMail_Address
required
string  [ 1 .. 128 ] characters 
Email address of the User.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
fax
string or null  <= 20 characters 
Fax number of the User.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the User's fax number.


 
grace_Logins
integer or null <int32> 
Identifies the number of login attempts that are allowed before the User's account is locked.


 
home_Phone
string or null  <= 32 characters 
Home phone number of the User.


 
home_Phone_Country_Code
string or null  <= 8 characters 
Country code of the User's home phone number.


 
iD_Card_Notification
required
boolean
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.


 
is_SSO_User
required
boolean
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.


 
login_Machine
string or null  <= 128 characters 
Identifies the machine on which the User is logged in.


 
login_Sound
string or null  <= 128 characters 
No Longer In Use


 
login_Status
integer or null <int32> 
Identifies the login status of the associated User.


 
mfA_Device_Name
string or null  <= 256 characters 
The device name for the authenticator being utilzied by this user.


 
mfA_Enabled
required
boolean
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.


 
name
string or null  <= 64 characters 
Name of the selected User.


 
nav_ID_Color
integer or null <int32> 
Identifies the color that will be used for navigation fields.


 
nav_ID_Type
string or null  <= 2 characters 
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.


 
nav_ID_Underline
required
boolean
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.


 
password
string or null  <= 32 characters 
Password of the selected User. Password requirements are set within the 'Application Settings' found from 'System Services' > 'VBA Control Panel'.


 
password_Expiration
string or null <date-time> 
Date when the User's password will expire.


 
phone
string or null  <= 20 characters 
Phone number of the User.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the User's phone number.


 
ssO_User_Name
string or null  <= 256 characters 
The SSO user name to be used during the Single Sign-On process.


 
single_Use_Account
required
boolean
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.


 
state
string or null  <= 2 characters 
State of the selected User's address.


 
title
string or null  <= 128 characters 
Title of the selected User.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
use_Windows_Authentication
required
boolean
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.


 
user_Idle
integer or null <int32> 
Identifies the idle time, in seconds, before the application closes.


 
user_Type
string or null  <= 16 characters 
Identifies the type associated with the User.


 
vbA_Password_Reset
required
boolean
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.


 
vbA_User
required
boolean
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.


 
zip_Code
string or null  <= 32 characters 
Zip code of the selected User's address.


 
Responses 
200
Success


401
Unauthorized


post/users
Request samples 
{
  • "user_ID": "string",
  • "account_Locked": true,
  • "address": "string",
  • "address2": "string",
  • "administrator": true,
  • "audit_User": true,
  • "can_Set_Allowed": "s",
  • "can_Set_Co_Ins": "s",
  • "can_Set_Not_Covered": "s",
  • "city": "string",
  • "claim_Maximum": 0.1,
  • "country_ID": "string",
  • "eMail_Address": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "grace_Logins": 0,
  • "home_Phone": "string",
  • "home_Phone_Country_Code": "string",
  • "iD_Card_Notification": true,
  • "is_SSO_User": true,
  • "login_Machine": "string",
  • "login_Sound": "string",
  • "login_Status": 0,
  • "mfA_Device_Name": "string",
  • "mfA_Enabled": true,
  • "name": "string",
  • "nav_ID_Color": 0,
  • "nav_ID_Type": "st",
  • "nav_ID_Underline": true,
  • "password": "string",
  • "password_Expiration": "2019-08-24T14:15:22Z",
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "ssO_User_Name": "string",
  • "single_Use_Account": true,
  • "state": "st",
  • "title": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Windows_Authentication": true,
  • "user_Idle": 0,
  • "user_Type": "string",
  • "vbA_Password_Reset": true,
  • "vbA_User": true,
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
List Users
Lists all Users


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/users
Request samples 
Response samples 
No sample
Get User
Gets a User by ID


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/users/{userID}
Request samples 
Response samples 
No sample
Update User
Updates a specific User


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
user_ID
required
string  [ 1 .. 16 ] characters 
User ID of the selected User.


 
account_Locked
required
boolean
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.


 
address
string or null  <= 255 characters 
Address of the selected User.


 
address2
string or null  <= 128 characters 
Address line 2 of the selected User.


 
administrator
required
boolean
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.


 
audit_User
required
boolean
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.


 
can_Set_Allowed
string or null  <= 1 characters 
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.


 
can_Set_Co_Ins
string or null  <= 1 characters 
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.


 
can_Set_Not_Covered
string or null  <= 1 characters 
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.


 
city
string or null  <= 32 characters 
City of the selected User's address.


 
claim_Maximum
number or null <double> 
When an adjudicated claim’s ‘Payable Amount’ exceeds this number, the ‘User Claim Max Exceeded’ Ex Code will be applied to the claim.


 
country_ID
string or null  <= 8 characters 
ID of the country of the User's address.


 
eMail_Address
required
string  [ 1 .. 128 ] characters 
Email address of the User.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
fax
string or null  <= 20 characters 
Fax number of the User.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the User's fax number.


 
grace_Logins
integer or null <int32> 
Identifies the number of login attempts that are allowed before the User's account is locked.


 
home_Phone
string or null  <= 32 characters 
Home phone number of the User.


 
home_Phone_Country_Code
string or null  <= 8 characters 
Country code of the User's home phone number.


 
iD_Card_Notification
required
boolean
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.


 
is_SSO_User
required
boolean
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.


 
login_Machine
string or null  <= 128 characters 
Identifies the machine on which the User is logged in.


 
login_Sound
string or null  <= 128 characters 
No Longer In Use


 
login_Status
integer or null <int32> 
Identifies the login status of the associated User.


 
mfA_Device_Name
string or null  <= 256 characters 
The device name for the authenticator being utilzied by this user.


 
mfA_Enabled
required
boolean
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.


 
name
string or null  <= 64 characters 
Name of the selected User.


 
nav_ID_Color
integer or null <int32> 
Identifies the color that will be used for navigation fields.


 
nav_ID_Type
string or null  <= 2 characters 
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.


 
nav_ID_Underline
required
boolean
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.


 
password
string or null  <= 32 characters 
Password of the selected User. Password requirements are set within the 'Application Settings' found from 'System Services' > 'VBA Control Panel'.


 
password_Expiration
string or null <date-time> 
Date when the User's password will expire.


 
phone
string or null  <= 20 characters 
Phone number of the User.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the User's phone number.


 
ssO_User_Name
string or null  <= 256 characters 
The SSO user name to be used during the Single Sign-On process.


 
single_Use_Account
required
boolean
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.


 
state
string or null  <= 2 characters 
State of the selected User's address.


 
title
string or null  <= 128 characters 
Title of the selected User.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
use_Windows_Authentication
required
boolean
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.


 
user_Idle
integer or null <int32> 
Identifies the idle time, in seconds, before the application closes.


 
user_Type
string or null  <= 16 characters 
Identifies the type associated with the User.


 
vbA_Password_Reset
required
boolean
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.


 
vbA_User
required
boolean
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.


 
zip_Code
string or null  <= 32 characters 
Zip code of the selected User's address.


 
Responses 
200
Success


401
Unauthorized


put/users/{userID}
Request samples 
{
  • "user_ID": "string",
  • "account_Locked": true,
  • "address": "string",
  • "address2": "string",
  • "administrator": true,
  • "audit_User": true,
  • "can_Set_Allowed": "s",
  • "can_Set_Co_Ins": "s",
  • "can_Set_Not_Covered": "s",
  • "city": "string",
  • "claim_Maximum": 0.1,
  • "country_ID": "string",
  • "eMail_Address": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax": "string",
  • "fax_Country_Code": "string",
  • "grace_Logins": 0,
  • "home_Phone": "string",
  • "home_Phone_Country_Code": "string",
  • "iD_Card_Notification": true,
  • "is_SSO_User": true,
  • "login_Machine": "string",
  • "login_Sound": "string",
  • "login_Status": 0,
  • "mfA_Device_Name": "string",
  • "mfA_Enabled": true,
  • "name": "string",
  • "nav_ID_Color": 0,
  • "nav_ID_Type": "st",
  • "nav_ID_Underline": true,
  • "password": "string",
  • "password_Expiration": "2019-08-24T14:15:22Z",
  • "phone": "string",
  • "phone_Country_Code": "string",
  • "ssO_User_Name": "string",
  • "single_Use_Account": true,
  • "state": "st",
  • "title": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Windows_Authentication": true,
  • "user_Idle": 0,
  • "user_Type": "string",
  • "vbA_Password_Reset": true,
  • "vbA_User": true,
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete User
Delete a User


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/users/{userID}
Request samples 
Create or Update Batch Users
Create or Update multiple Users at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
user_ID
required
string  [ 1 .. 16 ] characters 
User ID of the selected User.


 
account_Locked
required
boolean
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.


 
address
string or null  <= 255 characters 
Address of the selected User.


 
address2
string or null  <= 128 characters 
Address line 2 of the selected User.


 
administrator
required
boolean
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.


 
audit_User
required
boolean
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.


 
can_Set_Allowed
string or null  <= 1 characters 
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.


 
can_Set_Co_Ins
string or null  <= 1 characters 
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.


 
can_Set_Not_Covered
string or null  <= 1 characters 
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.


 
city
string or null  <= 32 characters 
City of the selected User's address.


 
claim_Maximum
number or null <double> 
When an adjudicated claim’s ‘Payable Amount’ exceeds this number, the ‘User Claim Max Exceeded’ Ex Code will be applied to the claim.


 
country_ID
string or null  <= 8 characters 
ID of the country of the User's address.


 
eMail_Address
required
string  [ 1 .. 128 ] characters 
Email address of the User.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
fax
string or null  <= 20 characters 
Fax number of the User.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the User's fax number.


 
grace_Logins
integer or null <int32> 
Identifies the number of login attempts that are allowed before the User's account is locked.


 
home_Phone
string or null  <= 32 characters 
Home phone number of the User.


 
home_Phone_Country_Code
string or null  <= 8 characters 
Country code of the User's home phone number.


 
iD_Card_Notification
required
boolean
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.


 
is_SSO_User
required
boolean
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.


 
login_Machine
string or null  <= 128 characters 
Identifies the machine on which the User is logged in.


 
login_Sound
string or null  <= 128 characters 
No Longer In Use


 
login_Status
integer or null <int32> 
Identifies the login status of the associated User.


 
mfA_Device_Name
string or null  <= 256 characters 
The device name for the authenticator being utilzied by this user.


 
mfA_Enabled
required
boolean
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.


 
name
string or null  <= 64 characters 
Name of the selected User.


 
nav_ID_Color
integer or null <int32> 
Identifies the color that will be used for navigation fields.


 
nav_ID_Type
string or null  <= 2 characters 
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.


 
nav_ID_Underline
required
boolean
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.


 
password
string or null  <= 32 characters 
Password of the selected User. Password requirements are set within the 'Application Settings' found from 'System Services' > 'VBA Control Panel'.


 
password_Expiration
string or null <date-time> 
Date when the User's password will expire.


 
phone
string or null  <= 20 characters 
Phone number of the User.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the User's phone number.


 
ssO_User_Name
string or null  <= 256 characters 
The SSO user name to be used during the Single Sign-On process.


 
single_Use_Account
required
boolean
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.


 
state
string or null  <= 2 characters 
State of the selected User's address.


 
title
string or null  <= 128 characters 
Title of the selected User.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
use_Windows_Authentication
required
boolean
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.


 
user_Idle
integer or null <int32> 
Identifies the idle time, in seconds, before the application closes.


 
user_Type
string or null  <= 16 characters 
Identifies the type associated with the User.


 
vbA_Password_Reset
required
boolean
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.


 
vbA_User
required
boolean
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.


 
zip_Code
string or null  <= 32 characters 
Zip code of the selected User's address.


 
Responses 
207
Success


401
Unauthorized


put/users-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}