APIs for VBASoftware
- Delete User
User Authentication
Refresh User Tokens
Change Temporary Password
Forgot Password
Confirm Forgot Password
User Change Password
Admin Reset User Password
Admin Disable User
Admin Enable User
Admin Resend Confirmation Code
Admin Resend Welcome Message
Submit MFA Code
Create User
List Users
Get User
Update User
Create or Update Batch Users
Delete User
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware/
Bodyrequired
- application/json
- text/json
- application/*+json
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.
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.
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.
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.
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.
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.
When an adjudicated claim’s ‘Payable Amount’ exceeds this number, the ‘User Claim Max Exceeded’ Ex Code will be applied to the claim.
Identifies the number of login attempts that are allowed before the User's account is locked.
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.
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.
The device name for the authenticator being utilzied by this user.
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.
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.
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 of the selected User. Password requirements are set within the 'Application Settings' found from 'System Services' > 'VBA Control Panel'.
The SSO user name to be used during the Single Sign-On process.
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.
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.
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.
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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/users/{userID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://vbapi.vbasoftware.com/vbasoftware/users/{userID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"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
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/users/{userID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/users/{userID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Body
- application/json
- text/json
- application/*+json
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.
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.
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.
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.
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.
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.
When an adjudicated claim’s ‘Payable Amount’ exceeds this number, the ‘User Claim Max Exceeded’ Ex Code will be applied to the claim.
Identifies the number of login attempts that are allowed before the User's account is locked.
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.
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.
The device name for the authenticator being utilzied by this user.
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.
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.
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 of the selected User. Password requirements are set within the 'Application Settings' found from 'System Services' > 'VBA Control Panel'.
The SSO user name to be used during the Single Sign-On process.
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.
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.
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.
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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/users-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://vbapi.vbasoftware.com/vbasoftware/users-batch \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '[
{
"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
No response example