Security Area User Groups

Create SecurityAreaUserGroup

Creates a new SecurityAreaUserGroup

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
securityArea
required
string

Security Area

header Parameters
vbasoftware-database
required
string

Target database

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

Security area that the User Group settings are being configured for.

userGroup_Key
required
integer <int32>

ID of the User Group that the level is being set for.

security_Level
required
integer <int32>

Security level that is being applied to the selected User.

Responses
200

Success

401

Unauthorized

post/security-areas/{securityArea}/user-groups
Request samples
{
  • "security_Area": "string",
  • "userGroup_Key": 0,
  • "security_Level": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SecurityAreaUserGroup

Lists all SecurityAreaUserGroup 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}/user-groups
Request samples 
Response samples 
No sample
Create or Update Batch SecurityAreaUserGroup
Create or Update multiple SecurityAreaUserGroup 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 
security_Area
required
string  [ 1 .. 16 ] characters 
Security area that the User Group settings are being configured for.


 
userGroup_Key
required
integer <int32> 
ID of the User Group that the level is being set for.


 
security_Level
required
integer <int32> 
Security level that is being applied to the selected User.


 
Responses 
207
Success


401
Unauthorized


put/security-areas/{securityArea}/user-groups
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Get SecurityAreaUserGroup
Gets SecurityAreaUserGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
userGroupKey
required
integer <int32> 
UserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/security-areas/{securityArea}/user-groups/{userGroupKey}
Request samples 
Response samples 
No sample
Delete SecurityAreaUserGroup
Deletes an SecurityAreaUserGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityArea
required
string
Security Area


 
userGroupKey
required
integer <int32> 
UserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/security-areas/{securityArea}/user-groups/{userGroupKey}
Request samples 
List Secure Groups
Lists all Secure Groups for a given User ID


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/secure-groups
Request samples 
Response samples 
No sample