Security Area Users

Create SecurityAreaUser

Creates a new SecurityAreaUser

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
securityArea
required
string

Security Area

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
user_ID
required
string [ 1 .. 16 ] characters

ID of the User whom the level is being set for.

security_Area
required
string [ 1 .. 16 ] characters

Security area that the User settings are being configured for.

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

security_Level
integer or null <int32>

Security level that is being applied to 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

Responses
200

Success

401

Unauthorized

post/security-areas/{securityArea}/users
Request samples
{
  • "user_ID": "string",
  • "security_Area": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "security_Level": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SecurityAreaUser

Lists all SecurityAreaUser given securityArea

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
securityArea
required
string

Security Area

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/security-areas/{securityArea}/users
Request samples 
Response samples 
No sample
Get SecurityAreaUser
Gets SecurityAreaUser


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/security-areas/{securityArea}/users/{userID}
Request samples 
Response samples 
No sample
Update SecurityAreaUser
Updates a specific SecurityAreaUser.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
user_ID
required
string  [ 1 .. 16 ] characters 
ID of the User whom the level is being set for.


 
security_Area
required
string  [ 1 .. 16 ] characters 
Security area that the User settings are being configured for.


 
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


 
security_Level
integer or null <int32> 
Security level that is being applied to 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


 
Responses 
200
Success


401
Unauthorized


put/security-areas/{securityArea}/users/{userID}
Request samples 
{
  • "user_ID": "string",
  • "security_Area": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "security_Level": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SecurityAreaUser
Deletes an SecurityAreaUser


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


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


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
user_ID
required
string  [ 1 .. 16 ] characters 
ID of the User whom the level is being set for.


 
security_Area
required
string  [ 1 .. 16 ] characters 
Security area that the User settings are being configured for.


 
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


 
security_Level
integer or null <int32> 
Security level that is being applied to 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


 
Responses 
207
Success


401
Unauthorized


put/security-areas/{securityArea}/users-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
List SecurityAreaUser for a User ID
Lists all SecurityAreaUser objects for a given User ID. This will show all of the Areas in which a User is a member.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/security-area-users
Request samples 
Response samples 
No sample