User Group Mappings

Create UserGroupMapping

Creates a new UserGroupMapping

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
userGroupKey
required
integer <int32>

UserGroup Key

userID
required
string

User ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

post/user-groups/{userGroupKey}/users/{userID}
Request samples 
Response samples 
No sample
Get UserGroupMapping
Gets UserGroupMapping


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userGroupKey
required
integer <int32> 
UserGroup Key


 
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/user-groups/{userGroupKey}/users/{userID}
Request samples 
Response samples 
No sample
Delete UserGroupMapping
Deletes an UserGroupMapping


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userGroupKey
required
integer <int32> 
UserGroup Key


 
userID
required
string
User ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/user-groups/{userGroupKey}/users/{userID}
Request samples 
List UserGroupMapping
Lists all UserGroupMapping for a specific userGroupKey


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userGroupKey
required
integer <int32> 
UserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/user-groups/{userGroupKey}/users
Request samples 
Response samples 
No sample
List UserGroupMapping
Lists all UserGroupMappings with optional filter for User_ID


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
User_ID
string
User_ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/user-group-mappings
Request samples 
Response samples 
No sample
Create multiple UserGroupMappings
Create multiple UserGroupMapping at once.  If the entity already exists, an error will be returned for that item. If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
userGroupKey
required
integer <int32> 
UserGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
userGroup_Key
required
integer <int32> 
ID of the User Group.


 
user_ID
required
string  [ 1 .. 16 ] characters 
ID of the User associated with the group mapping.


 
Responses 
207
Success


401
Unauthorized


put/user-groups/{userGroupKey}/users-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}