1. REST API for GoldenGate Veridata
  2. Tasks
  3. Manage User
  4. User Groups

Retrieve User Group

get

http://{host}:{port}/veridata/v1/services/admin/usergroups/{Id}

Required Role: Administrator, CommandLineOperator

Retrieve User Group

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Retrieved Group details successfully
Body ()
Root Schema : UserGroupDetails
Type: object
Show Source
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 : access
Type: array
Show Source
Nested Schema : users
Type: array
Show Source
Nested Schema : AccessList
Type: object
Show Source
Nested Schema : ListUser
Type: object
Match All
Show Source
Nested Schema : UserResponse
Type: object
Show Source
Nested Schema : ListUser-allOf[1]
Type: object

400 Response

Bad Request.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

Unauthorized.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

Not Found.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

Server Error.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}
Back to Top