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. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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
required
integer <int32>

Security level that is being applied to the selected User. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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}/user-groups
Request samples
{
  • "security_Area": "string",
  • "userGroup_Key": 0,
  • "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 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 records at once. If the entity exists, it will be updated; if it does not exist, it will be created. Please note: The Security_Area and UserGroup_Key fields represent the primary identifiers for these records and cannot be modified during an update. Ensure these values remain consistent with the original records when performing updates.


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. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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
required
integer <int32> 
Security level that is being applied to the selected User. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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}/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
Update SecurityAreaUserGroup
Updates an existing SecurityAreaUserGroup for the specified Security_Area and UserGroup_Key. Please note: The Security_Area and UserGroup_Key fields represent the primary identifiers for this record and cannot be modified during an update. These fields must match the values of the existing record being updated.


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


 
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. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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
required
integer <int32> 
Security level that is being applied to the selected User. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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}/user-groups/{userGroupKey}
Request samples 
{
  • "security_Area": "string",
  • "userGroup_Key": 0,
  • "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 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