Security User Restrictions

Create SecurityUserRestriction

Creates a new SecurityUserRestriction

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
securityUserRestriction_Key
required
integer <int32>

User Retriction Key

restriction_All
required
boolean

No Longer in use

restriction_Exclude
required
boolean

Selecting this option means that the User will have access to every subject of the same type EXCEPT the selected subject.

restriction_Field
string or null <= 64 characters

Identifies the subject of the associated restriction.

restriction_Value
string or null <= 128 characters

Subject that the restriction is being determined for. The User will ONLY have access to the selected subject - unless the ‘Exclude’ option is selected.

user_ID
string or null <= 20 characters

ID of the User to whom the restrictions will be applied.

Responses
200

Success

401

Unauthorized

post/security-user-restrictions
Request samples
{
  • "securityUserRestriction_Key": 0,
  • "restriction_All": true,
  • "restriction_Exclude": true,
  • "restriction_Field": "string",
  • "restriction_Value": "string",
  • "user_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List SecurityUserRestriction

Lists all SecurityUserRestriction

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
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-user-restrictions
Request samples 
Response samples 
No sample
Get SecurityUserRestriction
Gets SecurityUserRestriction


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityUserRestrictionKey
required
integer <int32> 
SecurityUserRestriction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/security-user-restrictions/{securityUserRestrictionKey}
Request samples 
Response samples 
No sample
Update SecurityUserRestriction
Updates a specific SecurityUserRestriction.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityUserRestrictionKey
required
integer <int32> 
SecurityUserRestriction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
securityUserRestriction_Key
required
integer <int32> 
User Retriction Key


 
restriction_All
required
boolean
No Longer in use


 
restriction_Exclude
required
boolean
Selecting this option means that the User will have access to every subject of the same type EXCEPT the selected subject.


 
restriction_Field
string or null  <= 64 characters 
Identifies the subject of the associated restriction.


 
restriction_Value
string or null  <= 128 characters 
Subject that the restriction is being determined for. The User will ONLY have access to the selected subject - unless the ‘Exclude’ option is selected.


 
user_ID
string or null  <= 20 characters 
ID of the User to whom the restrictions will be applied.


 
Responses 
200
Success


401
Unauthorized


put/security-user-restrictions/{securityUserRestrictionKey}
Request samples 
{
  • "securityUserRestriction_Key": 0,
  • "restriction_All": true,
  • "restriction_Exclude": true,
  • "restriction_Field": "string",
  • "restriction_Value": "string",
  • "user_ID": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete SecurityUserRestriction
Deletes an SecurityUserRestriction


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
securityUserRestrictionKey
required
integer <int32> 
SecurityUserRestriction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/security-user-restrictions/{securityUserRestrictionKey}
Request samples 
Create or Update Batch SecurityUserRestriction
Create or Update multiple SecurityUserRestriction 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 
securityUserRestriction_Key
required
integer <int32> 
User Retriction Key


 
restriction_All
required
boolean
No Longer in use


 
restriction_Exclude
required
boolean
Selecting this option means that the User will have access to every subject of the same type EXCEPT the selected subject.


 
restriction_Field
string or null  <= 64 characters 
Identifies the subject of the associated restriction.


 
restriction_Value
string or null  <= 128 characters 
Subject that the restriction is being determined for. The User will ONLY have access to the selected subject - unless the ‘Exclude’ option is selected.


 
user_ID
string or null  <= 20 characters 
ID of the User to whom the restrictions will be applied.


 
Responses 
207
Success


401
Unauthorized


put/security-user-restrictions-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}