REST API for GoldenGate Veridata

Login to Veridata

get

http://{host}:{port}/veridata/v1/auth/login

Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator

Retrieve User Authorization token. Pass Veridata User Credentials as part of Digest Authorization.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Security

DigestAuth: http

Type: http

Response

Supported Media Types

application/json

200 Response

Root Schema : Login

Type: object

Show Source

roles: array roles

User roles.
token: string

Authorization token.
userId: integer

User Id

{
    "type":"object",
    "properties":{
        "roles":{
            "type":"array",
            "description":"User roles.",
            "items":{
                "type":"string"
            }
        },
        "token":{
            "type":"string",
            "description":"Authorization token."
        },
        "userId":{
            "type":"integer",
            "description":"User Id"
        }
    }
}

Nested Schema : roles

Type: array

User roles.

Show Source

Array of: string

{
    "type":"array",
    "description":"User roles.",
    "items":{
        "type":"string"
    }
}

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