ジャンプ先

• リクエスト
• レスポンス

認可プロファイルのテスト

get

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

認可テナントへの接続のテスト

リクエスト

パス・パラメータ

• deployment: string
  最小長: 1

  最大長: 32

  パターン: ^[A-Za-z][A-Za-z0-9-_.]*$

  Oracle GoldenGateデプロイメントの名前。

• profile: string
  最小長: 1

  最大長: 32

  パターン: ^[A-Za-z][A-Za-z0-9-_.]*$

  認可プロファイルの名前。

• version: string

  Oracle GoldenGateサービスのAPIバージョン。

  指定できる値: [ "v2" ]

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

接続テストに成功しました

本文()

ルート・スキーマ: Oracle GoldenGate Authorization Profile Test Response definition

型: object

タイトル: Oracle GoldenGate Authorization Profile Test Response definition

認可プロファイルをテストするためのレスポンスを記述します

ソースの表示

• $schema(optional):
  指定できる値: [ "ogg:authorizationProfileTestResponse" ]
• testPassed: boolean
  テストに成功したかどうかを示すフラグ
• testReport: object testReport
  特定の各テストと、それらが成功したかどうかが表示されます。

{
    "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
}

ネストされたスキーマ: testReport

型: object

特定の各テストと、それらが成功したかどうかが表示されます。

ソースの表示

• incorrectProfileInformation(optional): array incorrectProfileInformation
  最小アイテム数: 0

  最大アイテム数: 10

  内部テストに失敗したすべての情報をリストします
• tenantUriReachable(optional): boolean
  テナントURIはアクセス可能か
• tenantUriValidOpenIdDiscoveryDocs(optional): boolean
  テナントURIに、必要なすべてのOpenID Discovery Docs情報が含まれているか
• tokenGetPossible(optional): boolean
  プロファイル情報を含むトークン・リクエストを作成できるか

{
    "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
}

ネストされたスキーマ: incorrectProfileInformation

型: array

最小アイテム数: 0

最大アイテム数: 10

内部テストに失敗したすべての情報をリストします

ソースの表示

• 配列: object items
  値の予想値と取得値に差があります。取得した値が空の場合、予期された値が存在しませんでした

{
    "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
}

ネストされたスキーマ: items

型: object

値の予想値と取得値に差があります。取得した値が空の場合、予期された値が存在しませんでした

ソースの表示

• expectedValue(optional): string
  最小長: 1

  最大長: 512
• name: string
  最小長: 1

  最大長: 512
• obtained(optional): string
  最小長: 1

  最大長: 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
}

レスポンスの例(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
        }
    }
}

先頭に戻る