Jump to

• Request
• Response

Validate

get

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

Check validity of credentials and return database credentials details.

Request

Path Parameters

• alias: string
  Minimum Length: 1

  Maximum Length: 30

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

  Credential store alias.

• domain: string
  Minimum Length: 1

  Maximum Length: 30

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

  Credential store domain name.

  Default Value: OracleGoldenGate
• version: string

  Oracle GoldenGate Service API version.

  Allowed Values: [ "v2" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

The user name and password associated with the alias are valid.

Body ()

Root Schema : Oracle GoldenGate Database Credentials Details

Type: object

Title: Oracle GoldenGate Database Credentials Details

Show Source

• $schema(optional):
  Allowed Values: [ "ogg:credentialsDetails" ]
• alias: string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
• catalogName(optional): catalogName
• domain: string
  Minimum Length: 1

  Maximum Length: 30

  Default Value: OracleGoldenGate

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

{
    "title":"Oracle GoldenGate Database Credentials Details",
    "required":[
        "alias",
        "domain",
        "serverName"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:credentialsDetails"
            ]
        },
        "serverName":{
            "x-oneOf":[
                {
                    "type":"string",
                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                    "minLength":1,
                    "maxLength":130
                }
            ]
        },
        "catalogName":{
            "x-oneOf":[
                {
                    "type":"string",
                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                    "minLength":1,
                    "maxLength":130
                }
            ]
        },
        "domain":{
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
            "minLength":1,
            "maxLength":30,
            "default":"OracleGoldenGate"
        },
        "alias":{
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
            "minLength":1,
            "maxLength":30
        }
    },
    "additionalProperties":false
}

Nested Schema : catalogName

Match One

Show Source

• string
  Minimum Length: 1

  Maximum Length: 130

  Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$

{
    "x-oneOf":[
        {
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":1,
            "maxLength":130
        }
    ]
}

Nested Schema : serverName

Match One

Show Source

• string
  Minimum Length: 1

  Maximum Length: 130

  Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$

{
    "x-oneOf":[
        {
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":1,
            "maxLength":130
        }
    ]
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/credentials/OracleGoldenGate/oggadmin/valid",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/credentials/OracleGoldenGate/oggadmin/valid",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/valid",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:credentialsDetails",
        "alias":"oggadmin",
        "domain":"OracleGoldenGate",
        "serverName":"ORCL"
    }
}

Back to Top