REST API for GoldenGate Veridata

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.

Response

Supported Media Types

application/json

200 Response

Retrieved Group details successfully

Root Schema : UserGroupDetails

Type: object

Show Source

access: array access
createdOn: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
description: string
id: integer (int64)

user group ID.
isModifiable: string
name: string
users: array users

{
    "properties":{
        "id":{
            "type":"integer",
            "description":"user group ID.",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "isModifiable":{
            "type":"string"
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "access":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AccessList"
            }
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ListUser"
            }
        }
    }
}

Nested Schema : access

Type: array

Show Source

Array of: object AccessList

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AccessList"
    }
}

Nested Schema : users

Type: array

Show Source

Array of: object ListUser

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ListUser"
    }
}

Nested Schema : AccessList

Type: object

Show Source

description: string
name: string
roleId: integer (int64)

user group ID.

{
    "type":"object",
    "properties":{
        "roleId":{
            "type":"integer",
            "description":"user group ID.",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : ListUser

Type: object

Match All

Show Source

object UserResponse
object ListUser-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserResponse"
        },
        {
            "type":"object"
        }
    ],
    "type":"object"
}

Nested Schema : UserResponse

Type: object

Show Source

description: string
emailId: string
name: string
userId: integer

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "emailId":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : ListUser-allOf[1]

Type: object

400 Response

Bad Request.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

401 Response

Unauthorized.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

404 Response

Not Found.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

500 Response

Server Error.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}