Patch Authorization Profile

patch

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

Required Role: Security

Patch the content of a given profile

Request

Supported Media Types
Path Parameters
Body ()
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
Nested Schema : Oracle GoldenGate Authorization Profile definition-x-oneOf[0]
Type: object
Profile for using the deployment's credential store
Show Source
  • Allowed Values: [ "ogg:authorizationProfile" ]
  • Minimum Length: 1
    Maximum Length: 4096
    Description of the local credential store
  • Default Value: false
    Flag to show whether the profile is enabled for the deployment or not
  • Allowed Values: [ "localCredentialStore" ]
    OGG local credential store
Nested Schema : Oracle GoldenGate Authorization Profile definition-x-oneOf[1]
Type: object
Profile for using an external Identity Provider
Show Source
  • Allowed Values: [ "ogg:authorizationProfile" ]
  • Minimum Length: 1
    Maximum Length: 256
    ClientID for Identity Provider app
  • Minimum Length: 1
    Maximum Length: 256
    Client secret for Identity Provider app
  • Minimum Length: 1
    Maximum Length: 1024
    Profile description
  • Default Value: false
    Flag to show whether the profile is enabled for the deployment or not
  • groupToRoles
    User mapping for Identity Provider groups to OGG roles
  • Minimum Length: 1
    Maximum Length: 4095
    Identity Domain in Oracle Access Manager
  • Minimum Value: 0
    Maximum Value: 4294967295
    Default Value: 3600
    Signing certificate Time-To-Live (seconds), 0 means check on every request
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    OpenID Connect server well-known discovery endpoint URI
  • Allowed Values: [ "idcs", "iam", "oam", "entraid" ]
    OpenID enabled server
Nested Schema : groupToRoles
Type: object
User mapping for Identity Provider groups to OGG roles
Show Source
Example Request (application/json)
{
    "clientID":"4a33ef81bf1642689ac83742a27b8a94",
    "clientSecret":"166155e9-884d-4eb3-9733-21f98f0698bc",
    "tenantDiscoveryURI":"https://idcs-17eca02d31a645e78710ad52ac01dd40.identity.c9dev2.oc9qadev.com/.well-known/openid-configuration",
    "groupToRoles":{
        "securityGroup":"Demo-source-security",
        "administratorGroup":"Demo-source-admin"
    },
    "enabled":true
}
Back to Top

Response

Supported Media Types

200 Response

The Authorization Profile was successfully altered

Body ()
Root Schema : RESTful API Standard Response
Type: object
Title: RESTful API Standard Response
Standard Response for all Oracle GoldenGate RESTful API calls
Show Source
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : response
Type: object
Oracle GoldenGate document from the request
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:message" ]
  • Minimum Length: 9
    Maximum Length: 9
    Pattern: ^OGG[-][0-9]{5}$
    The Oracle GoldenGate message code
  • Minimum Length: 20
    Maximum Length: 32
    Pattern: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
    The date and time that the message was issued
  • Allowed Values: [ "INFO", "WARNING", "ERROR" ]
    The severity of the message
  • Minimum Length: 1
    Maximum Length: 4095
    A human-readable description that provides information and detail specific to this occurence of the information, warning or error.
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    An absolute URI [RFC3986] to a page that describes the info, warning or error type.
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"
        }
    ],
    "messages":[
    ]
}
Back to Top