Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Retrieve Alias

get

/services/{version}/credentials/{domain}/{alias}

Required Role: User

Retrieve the available information for an alias in a credential store domain. The password for an alias will not be returned.

Request

Path Parameters

alias(required): string

Minimum Length: 1

Maximum Length: 30

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

Credential store alias.
domain(required): string

Minimum Length: 1

Maximum Length: 30

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

Credential store domain name.

Default Value: OracleGoldenGate
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

Details of the credential store alias returned successfully.

Root Schema : Oracle GoldenGate Database Credentials

Type: object

Title: Oracle GoldenGate Database Credentials

Show Source

$schema:

Allowed Values: [ "ogg:credentials" ]
password: string

Minimum Length: 1

Maximum Length: 1024
userid: string

Minimum Length: 1

Maximum Length: 4096

{
    "title":"Oracle GoldenGate Database Credentials",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:credentials"
            ]
        },
        "userid":{
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "password":{
            "type":"string",
            "minLength":"1",
            "maxLength":"1024"
        }
    },
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/credentials/OracleGoldenGate/ggnorth",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/credentials/OracleGoldenGate/ggnorth",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/alias",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:credentials",
        "userid":"c##ggadmin@//server1.dc1.north.example.com:1521/ORCLCDB"
    }
}