Oracle GoldenGate Microservices REST API

Retrieve User

get

/services/{version}/authorizations/{role}/{user}

Required Role: User

Get Authorization User Resource information.

Request

Path Parameters

role(required): string

Minimum Length: 1

Maximum Length: 256

Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$

Authorization Role Resource Name

Default Value: User
user(required): string

Minimum Length: 1

Maximum Length: 512

User Resource Name
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Successfully return Authorization User Resource information.

Root Schema : Oracle GoldenGate Service single User/Roles entry.

Type: object

Title: Oracle GoldenGate Service single User/Roles entry.

Show Source

$schema:

Allowed Values: [ "ogg:userRole" ]
credential: string

Minimum Length: 1

Maximum Length: 256
info: string

Minimum Length: 1

Maximum Length: 4095
role: string

Minimum Length: 1

Maximum Length: 256

Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
type:

Allowed Values: [ "Basic", "x-Cert" ]
user: string

Minimum Length: 1

Maximum Length: 512

{
    "title":"Oracle GoldenGate Service single User/Roles entry.",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:userRole"
            ]
        },
        "role":{
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
            "minLength":"1",
            "maxLength":"256"
        },
        "user":{
            "type":"string",
            "minLength":"1",
            "maxLength":"512"
        },
        "credential":{
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        },
        "info":{
            "type":"string",
            "minLength":"1",
            "maxLength":"4095"
        },
        "type":{
            "enum":[
                "Basic",
                "x-Cert"
            ]
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/authorizations/User/tkgguser03",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/authorizations/User/tkgguser03",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/user",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:userRole",
        "credential":"HzRB8n+yjbwkxvdXSlNaxQemHfrSAZ8hy4YN/05hVR8=",
        "info":"Example user #3",
        "role":"User",
        "type":"Basic",
        "user":"tkgguser03"
    }
}