Oracle Access Governance REST APIs

Find Permission Attributes

post

/access-governance/service-administration/20250331/orchestratedSystems/{orchestratedSystemId}/permissionAttributes

Returns metadata and a set of permissions associated with a given orchestrated system.

Request

Path Parameters

orchestratedSystemId(required): string

The unique id for an Orchestrated System. Available values can be found using the ListOrchestratedSystems operation.

Header Parameters

opc-request-id: string

The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

List of Permissions used to find attributes

Root Schema : OrchestratedSystemPermissionIdCollection

Type: object

A list of permission ids used to obtain a list of permission attributes.

Show Source

items(required): array items

List of permission ids.

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of permission ids.",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemPermissionId"
            }
        }
    },
    "description":"A list of permission ids used to obtain a list of permission attributes."
}

Nested Schema : items

Type: array

List of permission ids.

Show Source

Array of: object OrchestratedSystemPermissionId

Id of permission

{
    "type":"array",
    "description":"List of permission ids.",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemPermissionId"
    }
}

Nested Schema : OrchestratedSystemPermissionId

Type: object

Id of permission

Show Source

id(required): string

Id of permission

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of permission"
        }
    },
    "description":"Id of permission"
}

Response

Supported Media Types

application/json

200 Response

Permission Attributes Metadata

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : OrchestratedSystemAttributes

Type: object

The information about Orchestrated System attributes metadata

Show Source

items(required): array items

collection of account & permission attributes

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"collection of account & permission attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttribute"
            }
        }
    },
    "description":"The information about Orchestrated System attributes metadata"
}

Nested Schema : items

Type: array

collection of account & permission attributes

Show Source

Array of: object OrchestratedSystemAttribute

Account & permission attributes

{
    "type":"array",
    "description":"collection of account & permission attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttribute"
    }
}

Nested Schema : OrchestratedSystemAttribute

Type: object

Account & permission attributes

Show Source

accountAttributes: array accountAttributes

List of Orchestrated System account attributes
orchestratedSystem: object Info

Generic information object.
permissionAttributes: array permissionAttributes

List of Orchestrated System permission attributes

{
    "type":"object",
    "properties":{
        "orchestratedSystem":{
            "$ref":"#/definitions/Info"
        },
        "accountAttributes":{
            "type":"array",
            "description":"List of Orchestrated System account attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeData"
            }
        },
        "permissionAttributes":{
            "type":"array",
            "description":"List of Orchestrated System permission attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeData"
            }
        }
    },
    "description":"Account & permission attributes"
}

Nested Schema : accountAttributes

Type: array

List of Orchestrated System account attributes

Show Source

Array of: object OrchestratedSystemAttributeData

Orchestrated System Attributes

{
    "type":"array",
    "description":"List of Orchestrated System account attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeData"
    }
}

Nested Schema : Info

Type: object

Generic information object.

Show Source

displayName: string

Display Name of the entity.
id: string

id of the entity.
name: string

name of the entity.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the entity."
        },
        "name":{
            "type":"string",
            "description":"name of the entity."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the entity."
        }
    },
    "description":"Generic information object."
}

Nested Schema : permissionAttributes

Type: array

List of Orchestrated System permission attributes

Show Source

Array of: object OrchestratedSystemAttributeData

Orchestrated System Attributes

{
    "type":"array",
    "description":"List of Orchestrated System permission attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeData"
    }
}

Nested Schema : OrchestratedSystemAttributeData

Type: object

Orchestrated System Attributes

Show Source

children: array children

nested attributes
defaultValues: array defaultValues

Attribute Value
discriminator: string

this field signify attribute field is password
lookupType: string

LookupID for the attribute
name: string

Attribute name
permissionType: string

Permission Type
title: string

Display Name for the attribute.
type: string

Type of attribute

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Attribute name"
        },
        "type":{
            "type":"string",
            "description":"Type of attribute"
        },
        "title":{
            "type":"string",
            "description":"Display Name for the attribute."
        },
        "children":{
            "type":"array",
            "description":"nested attributes",
            "items":{
                "$ref":"#/definitions/NestedAttributes"
            }
        },
        "lookupType":{
            "type":"string",
            "description":"LookupID for the attribute"
        },
        "defaultValues":{
            "type":"array",
            "description":"Attribute Value",
            "items":{
                "type":"string"
            }
        },
        "permissionType":{
            "type":"string",
            "description":"Permission Type"
        },
        "discriminator":{
            "type":"string",
            "description":"this field signify attribute field is password"
        }
    },
    "description":"Orchestrated System Attributes"
}

Nested Schema : children

Type: array

nested attributes

Show Source

Array of: object NestedAttributes

Nested set of Orchestrated System attributes

{
    "type":"array",
    "description":"nested attributes",
    "items":{
        "$ref":"#/definitions/NestedAttributes"
    }
}

Nested Schema : defaultValues

Type: array

Attribute Value

Show Source

Array of: string

{
    "type":"array",
    "description":"Attribute Value",
    "items":{
        "type":"string"
    }
}

Nested Schema : NestedAttributes

Type: object

Nested set of Orchestrated System attributes

Show Source

items: array items

Orchestrated System attributes

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Orchestrated System attributes",
            "items":{
                "$ref":"#/definitions/OrchestratedSystemAttributeData"
            }
        }
    },
    "description":"Nested set of Orchestrated System attributes"
}

Nested Schema : items

Type: array

Orchestrated System attributes

Show Source

Array of: object OrchestratedSystemAttributeData

Orchestrated System Attributes

{
    "type":"array",
    "description":"Orchestrated System attributes",
    "items":{
        "$ref":"#/definitions/OrchestratedSystemAttributeData"
    }
}

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

409 Response

Conflict

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Default Response

Unknown Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

Examples

The following example shows how to retrieve permission attributes metadata by submitting a POST request. For example, you need this data for creating an access bundle. Replace placeholder values with actual values before running the sample command.

cURL Request Example

curl -i -X POST \
   -H "Authorization:Bearer <your access token>" \
   -H "Content-Type:application/json" \
   -d \
'{
    "items": [
       {
	"id": "privileges.ICF.da7efca4-8c7a-4d4f-8ad3-xxxxxxx27642f31e6ccda",
         "name": "ADMINISTER ANY SQL TUNING SET"
       },
         {
         "id": "privileges.ICF.da7efca4-8c7a-4d4f-8ad3-c55ac9362de6.xxxxxxxx51f96ab2f305cc7f11",
		"name": "ADMINISTER DATABASE TRIGGER"
       }]
}' \
 '${service-instance-url}/access-governance/service-administration/${versionID}/orchestratedSystems/${orchestratedSystemId}/permissionAttributes'

Example Request Payload

In your REST Client tool, submit the POST request

${service-instance-url}/access-governance/service-administration/${versionID}/orchestratedSystems/${orchestratedSystemId}/permissionAttributes

{
"items": [
       {
	"id": "privileges.ICF.da7efca4-8c7a-4d4f-8ad3-xxxxxxx27642f31e6ccda",
         "name": "ADMINISTER ANY SQL TUNING SET"
       },
         {
         "id": "privileges.ICF.da7efca4-8c7a-4d4f-8ad3-c55ac9362de6.xxxxxxxx51f96ab2f305cc7f11",
		"name": "ADMINISTER DATABASE TRIGGER"
       }
]
}

Example of the Response Code

You'll receive 200 OK response along with the following response body:

{
    "items": [
        {
            "orchestratedSystem": {
                "id": "bdxxff2a-xcxx-xxxx-xxxx-9baxxxfbbxec",
                "name": null,
                "displayName": null
            },
            "accountAttributes": null,
            "permissionAttributes": [
                {
                    "name": "groups.ICF.exaaxfxx-9eed-4a25-b8cc-a04c3fbxdxxa.xxde257cb525e0df8afxxxdxxxxxxe0",
                    "type": null,
                    "title": null,
                    "children": [
                    ],
                    "lookupType": null,
                    "permissionType": "__uid__",
                    "discriminator": null,
                    "defaultValues":[]
                }
            ]
        }
    ]
}