Retrieve User Group
get
http://{host}:{port}/veridata/v1/services/admin/usergroups/{Id}
Required Role: Administrator, CommandLineOperator
Retrieve User Group
Request
Path Parameters
- Id(required): integer(int64) group ID
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Retrieved Group details successfully
Root Schema : UserGroupDetails
Type:
Show Source object- access: array access
- createdOn: string (date-time) Pattern:
YYYY-MM-DDTHH:mm:ss.sssZExample:2024-02-03T10:15:30Z - description: string
- id: integer (int64) user group ID.
- isModifiable: string
- name: string
- users: array users
Example:
{ "id":0, "name":"UserGroup1", "description":"group1", "isModifiable":"false", "createdOn":"2024-02-03T10:15:30Z", "access":[ { "roleId":0, "name":"Admin", "description":"admin role" } ], "users":[ { "userId":0, "name":"User1", "emailId":"abc@oracle.com", "description":"user1" } ] }Nested Schema : AccessList
Type:
Show Source object- description: string
- name: string
- roleId: integer (int64) user group ID.
Nested Schema : ListUser-allOf[1]
Type:
object400 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" }