Oracle Access Governance REST APIs

Get a list of Permissions for an Orchestrated System

get

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

Returns a list of permissions associated with a given orchestrated system with support for pagination.

Request

Path Parameters

orchestratedSystemId(required): string

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

Query Parameters

domainName: string

Domain Name
keywordContains: string

Keyword to filter on from the following fields: displayName. Only one keyword may be provided.
limit: integer

Minimum Value: 1

Maximum Value: 1000

The maximum number of items to return.

Default Value: 10
page: string

Minimum Length: 1

A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
permissionTypeId: string

The id of the permission type that the permissions are attached to.
resourceType: string

The resource type filter to fetch permissions for OCI systems. Required when orchestratedSystem type is OCI.

Allowed Values: [ "APP_ROLE", "GROUP" ]
sortBy: string

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

Default Value: timeCreated

Allowed Values: [ "timeCreated", "displayName" ]
sortOrder: string

The sort order to use, either 'ASC' or 'DESC'.

Allowed Values: [ "ASC", "DESC" ]

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.

Response

Supported Media Types

application/json

200 Response

A page of Permission objects

Headers

opc-next-page: string

For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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 : PermissionCollection

Type: object

Results of a Permission search. PermissionSummary items.

Show Source

items(required): array items

List of PermissionSummary

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of PermissionSummary",
            "items":{
                "$ref":"#/definitions/PermissionSummary"
            }
        }
    },
    "description":"Results of a Permission search. PermissionSummary items."
}

Nested Schema : items

Type: array

List of PermissionSummary

Show Source

Array of: object PermissionSummary

Description of Permission.

{
    "type":"array",
    "description":"List of PermissionSummary",
    "items":{
        "$ref":"#/definitions/PermissionSummary"
    }
}

Nested Schema : PermissionSummary

Type: object

Description of Permission.

Show Source

description: string

Description of the permission
id(required): string

The Unique Oracle ID (OCID) that is immutable on creation
name: string

Name of the permission
permissionType: object PermissionTypeSummary

PermissionType Summary.
resource: object ResourceSummary

Resource Summary.
timeCreated: string(date-time)

Time when the permission was last created. An RFC3339 formatted datetime string
timeUpdated: string(date-time)

Time when the permission was last updated. An RFC3339 formatted datetime string
type: string

Type of the permission

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation"
        },
        "name":{
            "type":"string",
            "description":"Name of the permission"
        },
        "description":{
            "type":"string",
            "description":"Description of the permission"
        },
        "type":{
            "type":"string",
            "description":"Type of the permission"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the permission was last created. An RFC3339 formatted datetime string"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the permission was last updated. An RFC3339 formatted datetime string"
        },
        "resource":{
            "$ref":"#/definitions/ResourceSummary"
        },
        "permissionType":{
            "$ref":"#/definitions/PermissionTypeSummary"
        }
    },
    "description":"Description of Permission."
}

Nested Schema : PermissionTypeSummary

Type: object

PermissionType Summary.

Show Source

displayName: string

Display Name of the PermissionType.
externalId: string

External Id of the PermissionType
id: string

The Unique Oracle ID (OCID) that is immutable on creation.
name: string

name of the PermissionType.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "name":{
            "type":"string",
            "description":"name of the PermissionType."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the PermissionType."
        },
        "externalId":{
            "type":"string",
            "description":"External Id of the PermissionType"
        }
    },
    "description":"PermissionType Summary."
}

Nested Schema : ResourceSummary

Type: object

Resource Summary.

Show Source

customAttributes: object customAttributes

Metadata associated with the resource
displayName: string

Display Name of the Resource.
id(required): string

The Unique Oracle ID (OCID) that is immutable on creation.
name: string

name of the Resource.
type: string

Type of the Resource

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Unique Oracle ID (OCID) that is immutable on creation."
        },
        "name":{
            "type":"string",
            "description":"name of the Resource."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the Resource."
        },
        "type":{
            "type":"string",
            "description":"Type of the Resource"
        },
        "customAttributes":{
            "type":"object",
            "description":"Metadata associated with the resource",
            "properties":{
            }
        }
    },
    "description":"Resource Summary."
}

Nested Schema : customAttributes

Type: object

Metadata associated with the resource

Show Source

{
    "type":"object",
    "description":"Metadata associated with the resource",
    "properties":{
    }
}

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

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 a list of all permission specific to an Orchestrated System by submitting a GET request.

cURL Example - Without Query Parameters

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
'${service-instance-url}/access-governance/service-administration/20250331/orchestratedSystems/${orchestratedSystemId}/permissions'

Sample GET command using REST Client

curl -i -X GET \
   -H "Authorization:Bearer <your access token> \
'${service-instance-url}/access-governance/service-administration/20250331/orchestratedSystems/e4aa3f66-9eed-4a25-b8cc-a04c3fb2d84a/permissions'

Example of the Response Body

The following example shows the contents of the response body in JSON format, including a account profile:

{
    "items": [
        {
            "id": "groups.ICF.exaaxfxx-9eed-4a25-b8cc-a0xc3fb2xxxa.95dexxxcbxxxe0df8af649dx709915e0",
            "name": "AD_JML_GRP1",
            "description": null,
            "type": null,
            "timeCreated": "2024-08-12T13:44:07.205Z",
            "timeUpdated": null,
            "resource": {
                "id": "resource.ICF.e4aaxfxx-9eed-4axx-b8cc-a04c3fb2xxxa.exxxxxxe46exxa61exd7f067fc39be6f",
                "name": "AD System AG_App_Owner_Admin",
                "displayName": "AD System AG_App_Owner_Admin",
                "type": "RESOURCES",
                "customAttributes": null
            },
            "permissionType": {
                "id": "etype.ICF.e4aa3f66-9eed-xaxx-b8cc-axxc3fb2dxxa.936d9be0ce4c3ce91dxxxxc59cdaeaa3",
                "name": "icf.connector.entitlement.type.groups",
                "displayName": "Group",
                "externalId": "groups"
            }
        },
       {
            "id": "groups.ICF.exxx3f66-9eed-4axx-b8cc-a04c3fbxxxxa.edba9bxxxxxa0e7f0xxxxxxc99d1axxx",
            "name": "AD_JML_PERSONAS1",
            "description": null,
            "type": null,
            "timeCreated": "2024-08-12T14:34:43.034Z",
            "timeUpdated": null,
            "resource": {
                "id": "resource.ICF.e4aa3fxx-9xxx-4axx-b8cc-a04c3fbxxxxa.e427125e46e48a61e2d7f067fcxxxe6f",
                "name": "AD System AG_App_Owner_Admin",
                "displayName": "AD System AG_App_Owner_Admin",
                "type": "RESOURCES",
                "customAttributes": null
            },
            "permissionType": {
                "id": "etype.ICF.e4aa3f66-9eed-4axx-b8cc-a04c3fbxxx4a.9xxd9be0ce4c3cexxdxxx1c59cdaeaax",
                "name": "icf.connector.entitlement.type.groups",
                "displayName": "Group",
                "externalId": "groups"
            }
        }
    ]
}