Security Group Division Users

Create SecurityGroupDivisionUser

Creates a new SecurityGroupDivisionUser

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
securityGroupDivisionUser_Key
required
integer <int32>

Key of the SecurityGroupDivisionUser record

division_ID
string or null <= 20 characters

No longer in use

excluded
required
boolean

Selecting this option means that the User will have access to every group EXCEPT the selected Group.

group_ID
required
string [ 1 .. 20 ] characters

Identifier of the Group that the restriction is being configured for.

user_ID
required
string [ 1 .. 16 ] characters

ID of the User whom the restriction is being configured for.

Responses
200

Success

401

Unauthorized

post/security-group-division-users
Request samples
{
  • "securityGroupDivisionUser_Key": 0,
  • "division_ID": "string",
  • "excluded": true,
  • "group_ID": "string",
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SecurityGroupDivisionUser

Lists all SecurityGroupDivisionUser with optional userID and groupID filters

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
userID
string

User ID Filter

groupID
string

Group ID Filter

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/security-group-division-users
Request samples 
Response samples 
No sample
Get SecurityGroupDivisionUser
Gets SecurityGroupDivisionUser


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityGroupDivisionUserKey
required
integer <int32> 
SecurityGroupDivisionUser Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/security-group-division-users/{securityGroupDivisionUserKey}
Request samples 
Response samples 
No sample
Update SecurityGroupDivisionUser
Updates a specific SecurityGroupDivisionUser.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityGroupDivisionUserKey
required
integer <int32> 
SecurityGroupDivisionUser Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
securityGroupDivisionUser_Key
required
integer <int32> 
Key of the SecurityGroupDivisionUser record


 
division_ID
string or null  <= 20 characters 
No longer in use


 
excluded
required
boolean
Selecting this option means that the User will have access to every group EXCEPT the selected Group.


 
group_ID
required
string  [ 1 .. 20 ] characters 
Identifier of the Group that the restriction is being configured for.


 
user_ID
required
string  [ 1 .. 16 ] characters 
ID of the User whom the restriction is being configured for.


 
Responses 
200
Success


401
Unauthorized


put/security-group-division-users/{securityGroupDivisionUserKey}
Request samples 
{
  • "securityGroupDivisionUser_Key": 0,
  • "division_ID": "string",
  • "excluded": true,
  • "group_ID": "string",
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SecurityGroupDivisionUser
Deletes an SecurityGroupDivisionUser


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityGroupDivisionUserKey
required
integer <int32> 
SecurityGroupDivisionUser Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/security-group-division-users/{securityGroupDivisionUserKey}
Request samples 
Create or Update Batch SecurityGroupDivisionUser
Create or Update multiple SecurityGroupDivisionUser at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
securityGroupDivisionUser_Key
required
integer <int32> 
Key of the SecurityGroupDivisionUser record


 
division_ID
string or null  <= 20 characters 
No longer in use


 
excluded
required
boolean
Selecting this option means that the User will have access to every group EXCEPT the selected Group.


 
group_ID
required
string  [ 1 .. 20 ] characters 
Identifier of the Group that the restriction is being configured for.


 
user_ID
required
string  [ 1 .. 16 ] characters 
ID of the User whom the restriction is being configured for.


 
Responses 
207
Success


401
Unauthorized


put/security-group-division-users-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}