Create User Group
post
http://{host}:{port}/veridata/v1/services/admin/usergroups
Required Role: Administrator, SuperUser, CommandLineOperator
Create User Group
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source object- accessIds: array accessIds Array of access ids to be mapped to User Group.
- description: string
- name(required): string
Example:
{ "name":"AdminGroup", "description":"admin", "accessIds":[ 0 ] }Nested Schema : accessIds
Type:
arrayArray of access ids to be mapped to User Group.
Show Source - Array of: integer(int64) access Ids.
Response
Supported Media Types
- application/json
201 Response
User Group created successfully
Root Schema : UserGroupPostResponse
Type:
Show Source object- createdOn: string (date-time) Pattern:
YYYY-MM-DDTHH:mm:ss.sssZExample:2024-02-03T10:15:30Z - description: string
- id: integer
- isModifiable: string
- name: string
Example:
{ "id":1001, "name":"UserGroup1", "description":"group1", "isModifiable":"true", "createdOn":"2024-02-03T10:15:30Z" }400 Response
Bad Request.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }401 Response
Unauthorized.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }404 Response
Not Found.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }500 Response
Server Error.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }