Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Test Authorization Profile

get

/services/{version}/deployments/{deployment}/authorization/profiles/{profile}/valid

Required Role: Security

Test the connection to the Authorization Tenant

Request

Path Parameters

deployment(required): string

Minimum Length: 1

Maximum Length: 32

Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

Name for the Oracle GoldenGate deployment.
profile(required): string

Minimum Length: 1

Maximum Length: 32

Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

Name of Authorization profile.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

The connection test passed

Root Schema : Oracle GoldenGate Authorization Profile Test Response definition

Type: object

Title: Oracle GoldenGate Authorization Profile Test Response definition

Describes the response to test an Authorization Profile

Show Source

$schema:

Allowed Values: [ "ogg:authorizationProfileTestResponse" ]
testPassed(required): boolean

Flag to indicate whether the test passed or not
testReport(required): object testReport

Shows each specific test and whether they passed or not.

{
    "title":"Oracle GoldenGate Authorization Profile Test Response definition",
    "description":"Describes the response to test an Authorization Profile",
    "required":[
        "testPassed",
        "testReport"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:authorizationProfileTestResponse"
            ]
        },
        "testPassed":{
            "description":"Flag to indicate whether the test passed or not",
            "type":"boolean"
        },
        "testReport":{
            "description":"Shows each specific test and whether they passed or not.",
            "type":"object",
            "properties":{
                "tenantUriReachable":{
                    "description":"Is the Tenant URI reachable?",
                    "type":"boolean"
                },
                "tenantUriValidOpenIdDiscoveryDocs":{
                    "description":"Does the Tenant URI contain all the necessary OpenID Discovery Docs information",
                    "type":"boolean"
                },
                "tokenGetPossible":{
                    "description":"Can we create a token request with profile information?",
                    "type":"boolean"
                },
                "incorrectProfileInformation":{
                    "description":"Lists out all the information that failed internal test",
                    "type":"array",
                    "items":{
                        "description":"A value has a difference between its expected and obtained value. If obtained is empty, the value did not exist but was expected",
                        "type":"object",
                        "properties":{
                            "name":{
                                "type":"string",
                                "minLength":"1",
                                "maxLength":"512"
                            },
                            "expectedValue":{
                                "type":"string",
                                "minLength":"1",
                                "maxLength":"512"
                            },
                            "obtained":{
                                "type":"string",
                                "minLength":"1",
                                "maxLength":"512"
                            }
                        },
                        "required":[
                            "name"
                        ],
                        "additionalProperties":false
                    },
                    "minItems":"0",
                    "maxItems":"10"
                }
            },
            "additionalProperties":false
        }
    },
    "additionalProperties":false
}

Nested Schema : testReport

Type: object

Shows each specific test and whether they passed or not.

Show Source

incorrectProfileInformation: array incorrectProfileInformation

Minimum Number of Items: 0

Maximum Number of Items: 10

Lists out all the information that failed internal test
tenantUriReachable: boolean

Is the Tenant URI reachable?
tenantUriValidOpenIdDiscoveryDocs: boolean

Does the Tenant URI contain all the necessary OpenID Discovery Docs information
tokenGetPossible: boolean

Can we create a token request with profile information?

{
    "description":"Shows each specific test and whether they passed or not.",
    "type":"object",
    "properties":{
        "tenantUriReachable":{
            "description":"Is the Tenant URI reachable?",
            "type":"boolean"
        },
        "tenantUriValidOpenIdDiscoveryDocs":{
            "description":"Does the Tenant URI contain all the necessary OpenID Discovery Docs information",
            "type":"boolean"
        },
        "tokenGetPossible":{
            "description":"Can we create a token request with profile information?",
            "type":"boolean"
        },
        "incorrectProfileInformation":{
            "description":"Lists out all the information that failed internal test",
            "type":"array",
            "items":{
                "description":"A value has a difference between its expected and obtained value. If obtained is empty, the value did not exist but was expected",
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"512"
                    },
                    "expectedValue":{
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"512"
                    },
                    "obtained":{
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"512"
                    }
                },
                "required":[
                    "name"
                ],
                "additionalProperties":false
            },
            "minItems":"0",
            "maxItems":"10"
        }
    },
    "additionalProperties":false
}

Nested Schema : incorrectProfileInformation

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 10

Lists out all the information that failed internal test

Show Source

Array of: object items

A value has a difference between its expected and obtained value. If obtained is empty, the value did not exist but was expected

{
    "description":"Lists out all the information that failed internal test",
    "type":"array",
    "items":{
        "description":"A value has a difference between its expected and obtained value. If obtained is empty, the value did not exist but was expected",
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "minLength":"1",
                "maxLength":"512"
            },
            "expectedValue":{
                "type":"string",
                "minLength":"1",
                "maxLength":"512"
            },
            "obtained":{
                "type":"string",
                "minLength":"1",
                "maxLength":"512"
            }
        },
        "required":[
            "name"
        ],
        "additionalProperties":false
    },
    "minItems":"0",
    "maxItems":"10"
}

Nested Schema : items

Type: object

A value has a difference between its expected and obtained value. If obtained is empty, the value did not exist but was expected

Show Source

expectedValue: string

Minimum Length: 1

Maximum Length: 512
name(required): string

Minimum Length: 1

Maximum Length: 512
obtained: string

Minimum Length: 1

Maximum Length: 512

{
    "description":"A value has a difference between its expected and obtained value. If obtained is empty, the value did not exist but was expected",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "minLength":"1",
            "maxLength":"512"
        },
        "expectedValue":{
            "type":"string",
            "minLength":"1",
            "maxLength":"512"
        },
        "obtained":{
            "type":"string",
            "minLength":"1",
            "maxLength":"512"
        }
    },
    "required":[
        "name"
    ],
    "additionalProperties":false
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "rel":"canonical",
            "href":"https://slc11xmb.us.oracle.com:9000/services/v2/deployments/sourceDeployment/authorization/profiles/sourceProfile/valid",
            "mediaType":"application/json"
        },
        {
            "rel":"self",
            "href":"https://slc11xmb.us.oracle.com:9000/services/v2/deployments/sourceDeployment/authorization/profiles/sourceProfile/valid",
            "mediaType":"application/json"
        },
        {
            "rel":"describedby",
            "href":"https://slc11xmb.us.oracle.com:9000/services/v2/metadata-catalog/valid",
            "mediaType":"application/schema+json"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:authorizationProfileTestResponse",
        "testPassed":true,
        "testReport":{
            "tokenGetPossible":true,
            "tenantUriValidOpenIdDiscoveryDocs":true,
            "tenantUriReachable":true
        }
    }
}