Retrieve User Groups
get
http://{host}:{port}/veridata/v1/services/admin/usergroups
Required Role: Administrator, CommandLineOperator
Retrieve User Groups
Request
There are no request parameters for this operation.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Retrieved Group details successfully
Root Schema : schema
Type:
Show Source arrayExample:
[ { "id":1001, "name":"Admin", "description":"Admin", "isModifiable":"false", "createdOn":"2024-02-03T10:15:30Z" } ]Nested 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" }