REST API for GoldenGate Veridata

Replace User Group

put

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

Required Role: Administrator, CommandLineOperator

Replace User Group

Request

Path Parameters

Id(required): integer(int64)

group ID

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

accessIds: array accessIds

Array of access to be mapped to group.
description: string
userIds: array userIds

Array of users to be mapped to group.

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "accessIds":{
            "type":"array",
            "description":"Array of access to be mapped to group.",
            "items":{
                "type":"integer",
                "description":"access ID.",
                "format":"int64"
            }
        },
        "userIds":{
            "type":"array",
            "description":"Array of users to be mapped to group.",
            "items":{
                "type":"integer",
                "description":"user ID.",
                "format":"int64"
            }
        }
    }
}

Nested Schema : accessIds

Type: array

Array of access to be mapped to group.

Show Source

Array of: integer(int64)

access ID.

{
    "type":"array",
    "description":"Array of access to be mapped to group.",
    "items":{
        "type":"integer",
        "description":"access ID.",
        "format":"int64"
    }
}

Nested Schema : userIds

Type: array

Array of users to be mapped to group.

Show Source

Array of: integer(int64)

user ID.

{
    "type":"array",
    "description":"Array of users to be mapped to group.",
    "items":{
        "type":"integer",
        "description":"user ID.",
        "format":"int64"
    }
}

Response

Supported Media Types

application/json

200 Response

User Group updated successfully

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."
        }
    }
}