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

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 Top

Response

Supported Media Types

200 Response

Retrieved Group details successfully
Body ()
Root Schema : schema
Type: array
Show Source
Example:
[
    {
        "id":1001,
        "name":"Admin",
        "description":"Admin",
        "isModifiable":"false",
        "createdOn":"2024-02-03T10:15:30Z"
    }
]
Nested Schema : UserGroupPostResponse
Type: object
Show Source
Example:
{
    "id":1001,
    "name":"UserGroup1",
    "description":"group1",
    "isModifiable":"true",
    "createdOn":"2024-02-03T10:15:30Z"
}

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