ジャンプ先

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

認可プロファイルの取得

get

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

必要なロール: セキュリティ

指定されたデプロイメントにある特定の認可プロファイルのコンテンツを取得します

リクエスト

パス・パラメータ

• 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 definition

型: object

タイトル: Oracle GoldenGate Authorization Profile definition

OGGが使用する必要がある認可のタイプを記述します。

1つに一致

ソースの表示

• object Oracle GoldenGate Authorization Profile definition-x-oneOf[0]
  デプロイメントの資格証明ストアを使用するためのプロファイル
• object Oracle GoldenGate Authorization Profile definition-x-oneOf[1]
  IDCSをアイデンティティ・プロバイダとして使用するためのプロファイル

{
    "x-oneOf":[
        {
            "description":"Profile for using the deployment's credential store",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:authorizationProfile"
                    ]
                },
                "type":{
                    "description":"OGG local credential store",
                    "enum":[
                        "localCredentialStore"
                    ]
                },
                "description":{
                    "description":"Description of the local credential store",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"4096"
                },
                "enabled":{
                    "description":"Flag to show whether the profile is enabled for the deployment or not",
                    "type":"boolean",
                    "default":false
                }
            },
            "required":[
                "type"
            ],
            "additionalProperties":false
        },
        {
            "description":"Profile for using an IDCS as an Identity Provider",
            "properties":{
                "clientID":{
                    "description":"ClientID for IDCS app",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"256"
                },
                "identityDomain":{
                    "description":"Identity Domain in Oracle Access Manager",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"4095"
                },
                "groupToRoles":{
                    "description":"User mapping for IDCS groups to OGG roles",
                    "type":"object",
                    "properties":{
                        "securityGroup":{
                            "description":"Name of a group in IDCS",
                            "type":"string",
                            "minLength":"0",
                            "maxLength":"4095"
                        },
                        "administratorGroup":{
                            "description":"Name of a group in IDCS",
                            "type":"string",
                            "minLength":"0",
                            "maxLength":"4095"
                        },
                        "operatorGroup":{
                            "description":"Name of a group in IDCS",
                            "type":"string",
                            "minLength":"0",
                            "maxLength":"4095"
                        },
                        "userGroup":{
                            "description":"Name of a group in IDCS",
                            "type":"string",
                            "minLength":"0",
                            "maxLength":"4095"
                        }
                    },
                    "additionalProperties":false
                },
                "tenantDiscoveryURI":{
                    "description":"IDCS server well-known discovery endpoint URI",
                    "type":"string",
                    "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                    "minLength":"2",
                    "maxLength":"4095"
                },
                "enabled":{
                    "description":"Flag to show whether the profile is enabled for the deployment or not",
                    "type":"boolean",
                    "default":false
                },
                "$schema":{
                    "enum":[
                        "ogg:authorizationProfile"
                    ]
                },
                "type":{
                    "description":"OpenID enabled IDCS server",
                    "enum":[
                        "idcs",
                        "iam",
                        "oam"
                    ]
                },
                "signingCertificateTTL":{
                    "description":"Signing certificate Time-To-Live (seconds), 0 means check on every request",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"4294967295",
                    "default":"3600"
                },
                "clientSecret":{
                    "description":"Client secret for IDCS app",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"256"
                },
                "description":{
                    "description":"Profile description",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"1024"
                }
            },
            "additionalProperties":false
        }
    ],
    "title":"Oracle GoldenGate Authorization Profile definition",
    "description":"Describes the which type of authorization OGG should use.",
    "type":"object"
}

ネストされたスキーマ: Oracle GoldenGate Authorization Profile definition-x-oneOf[0]

型: object

デプロイメントの資格証明ストアを使用するためのプロファイル

ソースの表示

• $schema:
  指定できる値: [ "ogg:authorizationProfile" ]
• description: string
  最小長: 1

  最大長: 4096

  ローカル資格証明ストアの説明
• enabled: boolean
  デフォルト値: false

  プロファイルがデプロイメントに対して有効かどうかを示すフラグ
• type(必須):
  指定できる値: [ "localCredentialStore" ]

  OGGローカル資格証明ストア

{
    "description":"Profile for using the deployment's credential store",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:authorizationProfile"
            ]
        },
        "type":{
            "description":"OGG local credential store",
            "enum":[
                "localCredentialStore"
            ]
        },
        "description":{
            "description":"Description of the local credential store",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "enabled":{
            "description":"Flag to show whether the profile is enabled for the deployment or not",
            "type":"boolean",
            "default":false
        }
    },
    "required":[
        "type"
    ],
    "additionalProperties":false
}

ネストされたスキーマ: Oracle GoldenGate Authorization Profile definition-x-oneOf[1]

型: object

IDCSをアイデンティティ・プロバイダとして使用するためのプロファイル

ソースの表示

• $schema:
  指定できる値: [ "ogg:authorizationProfile" ]
• clientID: string
  最小長: 1

  最大長: 256

  IDCSアプリケーションのクライアントID
• clientSecret: string
  最小長: 1

  最大長: 256

  IDCSアプリケーションのクライアント・シークレット
• description: string
  最小長: 1

  最大長: 1024

  プロファイルの説明
• enabled: boolean
  デフォルト値: false

  プロファイルがデプロイメントに対して有効かどうかを示すフラグ
• groupToRoles: object groupToRoles
  IDCSグループからOGGロールへのユーザー・マッピング
• identityDomain: string
  最小長: 1

  最大長: 4095

  Oracle Access Managerのアイデンティティ・ドメイン
• signingCertificateTTL: integer
  最小値: 0

  最大値: 4294967295

  デフォルト値: 3600

  署名証明書存続時間(秒)、0はすべてのリクエストをチェックすることを意味します
• tenantDiscoveryURI: string
  最小長: 2

  最大長: 4095

  パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$

  IDCSサーバーの既知の検出エンドポイントURI
• type:
  指定できる値: [ "idcs", "iam", "oam" ]

  OpenID対応IDCSサーバー

{
    "description":"Profile for using an IDCS as an Identity Provider",
    "properties":{
        "clientID":{
            "description":"ClientID for IDCS app",
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        },
        "identityDomain":{
            "description":"Identity Domain in Oracle Access Manager",
            "type":"string",
            "minLength":"1",
            "maxLength":"4095"
        },
        "groupToRoles":{
            "description":"User mapping for IDCS groups to OGG roles",
            "type":"object",
            "properties":{
                "securityGroup":{
                    "description":"Name of a group in IDCS",
                    "type":"string",
                    "minLength":"0",
                    "maxLength":"4095"
                },
                "administratorGroup":{
                    "description":"Name of a group in IDCS",
                    "type":"string",
                    "minLength":"0",
                    "maxLength":"4095"
                },
                "operatorGroup":{
                    "description":"Name of a group in IDCS",
                    "type":"string",
                    "minLength":"0",
                    "maxLength":"4095"
                },
                "userGroup":{
                    "description":"Name of a group in IDCS",
                    "type":"string",
                    "minLength":"0",
                    "maxLength":"4095"
                }
            },
            "additionalProperties":false
        },
        "tenantDiscoveryURI":{
            "description":"IDCS server well-known discovery endpoint URI",
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
            "minLength":"2",
            "maxLength":"4095"
        },
        "enabled":{
            "description":"Flag to show whether the profile is enabled for the deployment or not",
            "type":"boolean",
            "default":false
        },
        "$schema":{
            "enum":[
                "ogg:authorizationProfile"
            ]
        },
        "type":{
            "description":"OpenID enabled IDCS server",
            "enum":[
                "idcs",
                "iam",
                "oam"
            ]
        },
        "signingCertificateTTL":{
            "description":"Signing certificate Time-To-Live (seconds), 0 means check on every request",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295",
            "default":"3600"
        },
        "clientSecret":{
            "description":"Client secret for IDCS app",
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        },
        "description":{
            "description":"Profile description",
            "type":"string",
            "minLength":"1",
            "maxLength":"1024"
        }
    },
    "additionalProperties":false
}

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

型: object

IDCSグループからOGGロールへのユーザー・マッピング

ソースの表示

• administratorGroup: string
  最小長: 0

  最大長: 4095

  IDCSのグループの名前
• operatorGroup: string
  最小長: 0

  最大長: 4095

  IDCSのグループの名前
• securityGroup: string
  最小長: 0

  最大長: 4095

  IDCSのグループの名前
• userGroup: string
  最小長: 0

  最大長: 4095

  IDCSのグループの名前

{
    "description":"User mapping for IDCS groups to OGG roles",
    "type":"object",
    "properties":{
        "securityGroup":{
            "description":"Name of a group in IDCS",
            "type":"string",
            "minLength":"0",
            "maxLength":"4095"
        },
        "administratorGroup":{
            "description":"Name of a group in IDCS",
            "type":"string",
            "minLength":"0",
            "maxLength":"4095"
        },
        "operatorGroup":{
            "description":"Name of a group in IDCS",
            "type":"string",
            "minLength":"0",
            "maxLength":"4095"
        },
        "userGroup":{
            "description":"Name of a group in IDCS",
            "type":"string",
            "minLength":"0",
            "maxLength":"4095"
        }
    },
    "additionalProperties":false
}

レスポンスの例(application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "rel":"canonical",
            "href":"https://slc11xmb.us.oracle.com:9000/services/v2/deployments/sourceDeployment/authorization/profiles/sourceProfile",
            "mediaType":"application/json"
        },
        {
            "rel":"self",
            "href":"https://slc11xmb.us.oracle.com:9000/services/v2/deployments/sourceDeployment/authorization/profiles/sourceProfile",
            "mediaType":"application/json"
        },
        {
            "rel":"describedby",
            "href":"https://slc11xmb.us.oracle.com:9000/services/v2/metadata-catalog/profile",
            "mediaType":"application/schema+json"
        }
    ],
    "messages":[
    ],
    "response":{
        "type":"idcs",
        "clientID":"4a33ef81bf1642689ac83742a27b8a94",
        "groupToRoles":{
            "securityGroup":"Demo-source-security"
        },
        "tenantDiscoveryURI":"https://idcs-17eca02d31a645e78710ad52ac01dd40.identity.c9dev2.oc9qadev.com/.well-known/openid-configuration",
        "description":"",
        "enabled":true,
        "clientSecret":"*****",
        "$schema":"ogg:authorizationProfile"
    }
}

先頭に戻る