Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

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.

Title: Oracle GoldenGate Service single User/Roles entry.

Match Any

Show Source

object Oracle GoldenGate Service single User/Roles entry.-x-anyOf[0]
object Oracle GoldenGate Service single User/Roles entry.-x-anyOf[1]

{
    "x-anyOf":[
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:userRole"
                    ]
                },
                "role":{
                    "enum":[
                        "User",
                        "Operator",
                        "Administrator",
                        "Security"
                    ]
                },
                "type":{
                    "enum":[
                        "Basic"
                    ]
                },
                "user":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"512"
                },
                "info":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"4095"
                },
                "credential":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"256"
                }
            },
            "additionalProperties":false
        },
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:userRole"
                    ]
                },
                "role":{
                    "enum":[
                        "User",
                        "Operator",
                        "Administrator",
                        "Security"
                    ]
                },
                "type":{
                    "enum":[
                        "x-Cert"
                    ]
                },
                "user":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"512"
                },
                "info":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"4095"
                },
                "certificateBundle":{
                    "description":"PEM encoded X.509 Certificate Data with Private-Key Data",
                    "type":"object",
                    "properties":{
                        "certificatePem":{
                            "type":"string",
                            "minLength":"1",
                            "maxLength":"523288"
                        },
                        "privateKeyPem":{
                            "type":"string",
                            "minLength":"1",
                            "maxLength":"523288"
                        },
                        "caCertificates":{
                            "description":"A collection of PEM encoded ca certificates.",
                            "type":"array",
                            "minItems":"1",
                            "maxItems":"128",
                            "items":{
                                "type":"string",
                                "minLength":"1",
                                "maxLength":"523288"
                            }
                        }
                    },
                    "required":[
                        "certificatePem"
                    ],
                    "additionalProperties":false
                }
            },
            "additionalProperties":false
        }
    ],
    "title":"Oracle GoldenGate Service single User/Roles entry."
}

Nested Schema : Oracle GoldenGate Service single User/Roles entry.-x-anyOf[0]

Type: object

Show Source

$schema:

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

Minimum Length: 1

Maximum Length: 256
info: string

Minimum Length: 1

Maximum Length: 4095
role:

Allowed Values: [ "User", "Operator", "Administrator", "Security" ]
type:

Allowed Values: [ "Basic" ]
user: string

Minimum Length: 1

Maximum Length: 512

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:userRole"
            ]
        },
        "role":{
            "enum":[
                "User",
                "Operator",
                "Administrator",
                "Security"
            ]
        },
        "type":{
            "enum":[
                "Basic"
            ]
        },
        "user":{
            "type":"string",
            "minLength":"1",
            "maxLength":"512"
        },
        "info":{
            "type":"string",
            "minLength":"1",
            "maxLength":"4095"
        },
        "credential":{
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        }
    },
    "additionalProperties":false
}

Nested Schema : Oracle GoldenGate Service single User/Roles entry.-x-anyOf[1]

Type: object

Show Source

$schema:

Allowed Values: [ "ogg:userRole" ]
certificateBundle: object certificateBundle

PEM encoded X.509 Certificate Data with Private-Key Data
info: string

Minimum Length: 1

Maximum Length: 4095
role:

Allowed Values: [ "User", "Operator", "Administrator", "Security" ]
type:

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

Minimum Length: 1

Maximum Length: 512

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:userRole"
            ]
        },
        "role":{
            "enum":[
                "User",
                "Operator",
                "Administrator",
                "Security"
            ]
        },
        "type":{
            "enum":[
                "x-Cert"
            ]
        },
        "user":{
            "type":"string",
            "minLength":"1",
            "maxLength":"512"
        },
        "info":{
            "type":"string",
            "minLength":"1",
            "maxLength":"4095"
        },
        "certificateBundle":{
            "description":"PEM encoded X.509 Certificate Data with Private-Key Data",
            "type":"object",
            "properties":{
                "certificatePem":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"523288"
                },
                "privateKeyPem":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"523288"
                },
                "caCertificates":{
                    "description":"A collection of PEM encoded ca certificates.",
                    "type":"array",
                    "minItems":"1",
                    "maxItems":"128",
                    "items":{
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"523288"
                    }
                }
            },
            "required":[
                "certificatePem"
            ],
            "additionalProperties":false
        }
    },
    "additionalProperties":false
}

Nested Schema : certificateBundle

Type: object

PEM encoded X.509 Certificate Data with Private-Key Data

Show Source

caCertificates: array caCertificates

Minimum Number of Items: 1

Maximum Number of Items: 128

A collection of PEM encoded ca certificates.
certificatePem(required): string

Minimum Length: 1

Maximum Length: 523288
privateKeyPem: string

Minimum Length: 1

Maximum Length: 523288

{
    "description":"PEM encoded X.509 Certificate Data with Private-Key Data",
    "type":"object",
    "properties":{
        "certificatePem":{
            "type":"string",
            "minLength":"1",
            "maxLength":"523288"
        },
        "privateKeyPem":{
            "type":"string",
            "minLength":"1",
            "maxLength":"523288"
        },
        "caCertificates":{
            "description":"A collection of PEM encoded ca certificates.",
            "type":"array",
            "minItems":"1",
            "maxItems":"128",
            "items":{
                "type":"string",
                "minLength":"1",
                "maxLength":"523288"
            }
        }
    },
    "required":[
        "certificatePem"
    ],
    "additionalProperties":false
}

Nested Schema : caCertificates

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 128

A collection of PEM encoded ca certificates.

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 523288

{
    "description":"A collection of PEM encoded ca certificates.",
    "type":"array",
    "minItems":"1",
    "maxItems":"128",
    "items":{
        "type":"string",
        "minLength":"1",
        "maxLength":"523288"
    }
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/authorizations/User/ggmsuser01",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/authorizations/User/ggmsuser01",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/user",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:userRole",
        "info":"Credential Information",
        "role":"User",
        "type":"Basic",
        "user":"ggmsuser01"
    }
}