Support

List All Clients

Lists the clients

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Support Database

Responses
200

Success

401

Unauthorized

get/support/clients
Request samples 
Response samples 
No sample
Get Client
Gets the client details for the given client id and client code.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
clientId
required
string
Client ID


 
clientCode
required
string
Client Code


 
header Parameters
vbasoftware-database
required
string
Support Database


 
Responses 
200
Success


401
Unauthorized


get/support/client
Request samples 
Response samples 
No sample
Create Support User in a client environment
This endpoint allows you to create a support user and add them to a specific client's database.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
userIdToClone
string
Client User ID to Clone


 
makeAdmin
boolean
 Default:  false
Make Administrator


 
header Parameters
vbasoftware-database
required
string
Support Database


 
target-vbasoftware-client-id
required
string
Target Client ID


 
target-vbasoftware-client-code
required
string
Target Client Code


 
target-vbasoftware-database
required
string
Target Client Database


 
Responses 
200
Success


401
Unauthorized


post/support/client-users/add-me
Request samples 
Response samples 
No sample
Disables the Support User in a client environment
This endpoint allows you to disable the currently authenticated Support user within the client's environment instead of deleting them.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Support Database


 
target-vbasoftware-client-id
required
string
Target Client ID


 
target-vbasoftware-client-code
required
string
Target Client Code


 
target-vbasoftware-database
required
string
Target Client Database


 
Responses 
204
Success


401
Unauthorized


post/support/client-users/disable-me
Request samples 
List of all Users in a client environment
SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Support Database


 
target-vbasoftware-client-id
required
string
Target Client ID


 
target-vbasoftware-client-code
required
string
Target Client Code


 
target-vbasoftware-database
required
string
Target Client Database


 
Responses 
200
Success


401
Unauthorized


get/support/client-users
Request samples 
Response samples 
No sample