Oracle GoldenGate 23ai Microservices Architecture REST API Documentation

Get Authorization Profile

get

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

Required Role: Security

Get the content of a specific Authorization profile in a given deployment

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 Authorization profile was queried successfully

Root Schema : Oracle GoldenGate Authorization Profile definition

Type: object

Title: Oracle GoldenGate Authorization Profile definition

Describes the which type of authorization OGG should use.

Match One

Show Source

object Oracle GoldenGate Authorization Profile definition-x-oneOf[0]

Profile for using the deployment's credential store
object Oracle GoldenGate Authorization Profile definition-x-oneOf[1]

Profile for using an IDCS as an Identity Provider

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

Nested Schema : Oracle GoldenGate Authorization Profile definition-x-oneOf[0]

Type: object

Profile for using the deployment's credential store

Show Source

$schema:

Allowed Values: [ "ogg:authorizationProfile" ]
description: string

Minimum Length: 1

Maximum Length: 4096

Description of the local credential store
enabled: boolean

Default Value: false

Flag to show whether the profile is enabled for the deployment or not
type(required):

Allowed Values: [ "localCredentialStore" ]

OGG local credential store

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

Nested Schema : Oracle GoldenGate Authorization Profile definition-x-oneOf[1]

Type: object

Profile for using an IDCS as an Identity Provider

Show Source

$schema:

Allowed Values: [ "ogg:authorizationProfile" ]
clientID: string

Minimum Length: 1

Maximum Length: 256

ClientID for IDCS app
clientSecret: string

Minimum Length: 1

Maximum Length: 256

Client secret for IDCS app
description: string

Minimum Length: 1

Maximum Length: 1024

Profile description
enabled: boolean

Default Value: false

Flag to show whether the profile is enabled for the deployment or not
groupToRoles: object groupToRoles

User mapping for IDCS groups to OGG roles
identityDomain: string

Minimum Length: 1

Maximum Length: 4095

Identity Domain in Oracle Access Manager
signingCertificateTTL: integer

Minimum Value: 0

Maximum Value: 4294967295

Default Value: 3600

Signing certificate Time-To-Live (seconds), 0 means check on every request
tenantDiscoveryURI: string

Minimum Length: 2

Maximum Length: 4095

Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$

IDCS server well-known discovery endpoint URI
type:

Allowed Values: [ "idcs", "iam", "oam" ]

OpenID enabled IDCS server

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

Nested Schema : groupToRoles

Type: object

User mapping for IDCS groups to OGG roles

Show Source

administratorGroup: string

Minimum Length: 0

Maximum Length: 4095

Name of a group in IDCS
operatorGroup: string

Minimum Length: 0

Maximum Length: 4095

Name of a group in IDCS
securityGroup: string

Minimum Length: 0

Maximum Length: 4095

Name of a group in IDCS
userGroup: string

Minimum Length: 0

Maximum Length: 4095

Name of a group in 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
}

Example Response (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"
    }
}