Get Permissions

post

/access-governance/access-reviews/20250331/campaigns/permissions

Retrieves a list of permissions for running access reviews.

Request

Query Parameters
  • Minimum Value: 1
    Maximum Value: 1000
    The maximum number of items to return.
    Default Value: 10
  • 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.
  • 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" ]
  • The sort order to use, either 'ASC' or 'DESC'.
    Allowed Values: [ "ASC", "DESC" ]
Header Parameters
  • The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.
Body ()
The filters to apply.
Root Schema : KeywordFilteredDetails
Type: object
The filters to apply along with the keyword contains filters.
Show Source
Nested Schema : criteria
Type: array
Maximum Number of Items: 20
The list of criteria.
Show Source
Nested Schema : Criteria
Type: object
The criteria to use as a filter.
Show Source
  • conditions
    Maximum Number of Items: 100
    Filter condition (these conditions have an AND binding between them).
  • subCriteria
    The list of values of the criteria.
  • Allowed Values: [ "ORGANIZATION", "JOB_CODE", "IDENTITY_LOCATION", "RESOURCE", "RESOURCE_LOCATION", "ENTITLEMENT", "ROLE", "DOMAIN", "COMPARTMENT", "CLOUD_PROVIDER", "POLICY", "POLICY_CREATED", "CUSTOM_ATTRIBUTE", "CUSTOM_ATTRIBUTE_VALUE", "IDENTITY_COLLECTION", "IC_CREATED", "TARGET_IDENTITY", "TARGET", "GLOBAL_IDENTITY", "AM_WORKFLOW", "NOT_REVIEWED_SINCE", "ACCESS_GUARDRAIL", "GRANTED_PERMISSION_TYPE", "TEMPORAL_TYPE" ]
    The type of the criteria.
  • value
    Maximum Number of Items: 500
    The list of values of the criteria (these values have an OR binding between them).
Nested Schema : conditions
Type: array
Maximum Number of Items: 100
Filter condition (these conditions have an AND binding between them).
Show Source
Nested Schema : subCriteria
Type: array
The list of values of the criteria.
Show Source
Nested Schema : value
Type: array
Maximum Number of Items: 500
The list of values of the criteria (these values have an OR binding between them).
Show Source
Nested Schema : Condition
Type: object
The information about Condition.
Show Source
Nested Schema : additionalAttributes
Type: object
Additional Properties Allowed
Show Source
Additional attributes for additional information related to the condition.
Nested Schema : BasicCondition
Type: object
The information about Condition.
Show Source
  • Allowed Values: [ "STRING", "NUMBER", "BOOLEAN", "DATE" ]
    Data type for the condition Identifier
  • Minimum Length: 1
    Maximum Length: 255
    Access Guardrails Identifier
  • Minimum Length: 1
    Maximum Length: 512
    Left hand side of the condition.
  • Allowed Values: [ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TILL", "FROM", "BETWEEN", "NOT_BETWEEN", "IN", "NOT_IN", "CONTAINS", "NOT_CONTAINS", "BEGINS_WITH", "NOT_BEGINS_WITH", "ENDS_WITH", "NOT_ENDS_WITH", "IS_NULL", "IS_NOT_NULL", "EQUAL_WITH_NULL" ]
    The operator for a access guardrail.
  • rhs
    Right hand side of the condition.
  • rhsUiDetails
    Right hand side details of the condition.
Nested Schema : BasicConditionCollection
Type: object
Collection of conditions.
Show Source
Nested Schema : rhs
Type: array
Right hand side of the condition.
Show Source
Nested Schema : rhsUiDetails
Type: array
Right hand side details of the condition.
Show Source
Nested Schema : UiDetail
Type: object
Ui detail for rendering values on UI
Show Source
Nested Schema : items
Type: array
List of condition.
Show Source
Back to Top

Response

Supported Media Types

200 Response

A page of permission objects.
Headers
  • 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.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : EntitlementSummaryCollection
Type: object
Results of a permission search.
Show Source
Nested Schema : items
Type: array
List of permission summaries.
Show Source
Nested Schema : EntitlementSummary
Type: object
The summary of a permission.
Show Source

400 Response

Bad Request
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

401 Response

Unauthorized
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

404 Response

Not Found
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

429 Response

Too Many Requests
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

500 Response

Internal Server Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source

Default Response

Unknown Error
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
Body ()
Root Schema : Error
Type: object
Error Information.
Show Source
Back to Top

Examples

The following example shows how to retrieve a list of Permissions (Groups, Roles, and Privileges) available in Oracle Access Governance.

cURL Request Example

curl -i -L -X POST \
   -H "Authorization:Bearer <your long access token>" \
   -H "Content-Type:application/json" \
   -d \
'{
"criteria": [
    {
      "type": "CUSTOM_ATTRIBUTE",
      "value": [
        "organization.displayName"
      ],
      "subCriteria": [
        {
          "type": "CUSTOM_ATTRIBUTE_VALUE",
          "value": [
            "Security"
          ]
        }
      ]
    }
  ],
  "scope": "AG",
  "campaignType": "ACCESS"
}' \
 '<${service-instance-url}/access-governance/access-reviews/${version}/campaigns/permissions>'

Sample Request Payload

Select POST and add the following URL
${service-instance-url}/access-governance/access-reviews/${version}/campaigns/permissions
{
  "criteria": [
    {
      "type": "CUSTOM_ATTRIBUTE",
      "value": [
        "organization.displayName"
      ],
      "subCriteria": [
        {
          "type": "CUSTOM_ATTRIBUTE_VALUE",
          "value": [
            "Security"
          ]
        }
      ]
    }
  ],
  "scope": "AG",
  "campaignType": "ACCESS"
}

Example of the Response Code

You'll receive 200 response with the following body:
{
  "items": [
    {
      "id": "groups.ICF.xxTEAMID1.xxxxxxxxGROUPID001",
      "name": "Finance Security Group",
      "displayName": null,
      "resourceDisplayName": "AD_SECURITY_DEPT",
      "permissionType": "Group",
      "cloudAccount": null,
      "domainName": null,
      "isBundle": false,
      "expirationTime": 0,
      "accessLimitType": null
    },
    {
      "id": "groups.ICF.xxTEAMID1.xxxxxxxxGROUPID002",
      "name": "HR Security Group",
      "displayName": null,
      "resourceDisplayName": "AD_SECURITY_DEPT",
      "permissionType": "Group",
      "cloudAccount": null,
      "domainName": null,
      "isBundle": false,
      "expirationTime": 0,
      "accessLimitType": null
    },
    {
      "id": "groups.ICF.xxTEAMID1.xxxxxxxxGROUPID003",
      "name": "IT Security Group",
      "displayName": null,
      "resourceDisplayName": "AD_SECURITY_DEPT",
      "permissionType": "Group",
      "cloudAccount": null,
      "domainName": null,
      "isBundle": false,
      "expirationTime": 0,
      "accessLimitType": null
    },
    {
      "id": "groups.ICF.xxTEAMID2.xxxxxxxxGROUPID004",
      "name": "Security-AdminRole1",
      "displayName": null,
      "resourceDisplayName": "OUD_SEC_ADMIN",
      "permissionType": "Group Name",
      "cloudAccount": null,
      "domainName": null,
      "isBundle": false,
      "expirationTime": 0,
      "accessLimitType": null
    },
    {
      "id": "groups.ICF.xxTEAMID2.xxxxxxxxGROUPID005",
      "name": "Security-AdminRole2",
      "displayName": null,
      "resourceDisplayName": "OUD_SEC_ADMIN",
      "permissionType": "Group Name",
      "cloudAccount": null,
      "domainName": null,
      "isBundle": false,
      "expirationTime": 0,
      "accessLimitType": null
    },
    {
      "id": "privileges.ICF.xxPRIVID1.xxxxxxxxPRIVID001",
      "name": "ALTER USER",
      "displayName": null,
      "resourceDisplayName": "CORP_DBUM_MAIN",
      "permissionType": "Privilege",
      "cloudAccount": null,
      "domainName": null,
      "isBundle": false,
      "expirationTime": 0,
      "accessLimitType": null
    },
    {
      "id": "privileges.ICF.xxPRIVID2.xxxxxxxxPRIVID002",
      "name": "ALTER USER",
      "displayName": null,
      "resourceDisplayName": "ENTERPRISE_DBUM",
      "permissionType": "Privilege",
      "cloudAccount": null,
      "domainName": null,
      "isBundle": false,
      "expirationTime": 0,
      "accessLimitType": null
    },
    {
      "id": "roles.ICF.xxROLEID1.xxxxxxxxROLEID001",
      "name": "SEC_DATA_ROLE",
      "displayName": null,
      "resourceDisplayName": "CORP_DBUM_MAIN",
      "permissionType": "Role",
      "cloudAccount": null,
      "domainName": null,
      "isBundle": false,
      "expirationTime": 0,
      "accessLimitType": null
    },
    {
      "id": "roles.ICF.xxROLEID2.xxxxxxxxROLEID002",
      "name": "SEC_DATA_ROLE",
      "displayName": null,
      "resourceDisplayName": "ENTERPRISE_DBUM",
      "permissionType": "Role",
      "cloudAccount": null,
      "domainName": null,
      "isBundle": false,
      "expirationTime": 0,
      "accessLimitType": null
    },
    {
      "id": "privileges.ICF.xxPRIVID1.xxxxxxxxPRIVID003",
      "name": "CREATE SESSION",
      "displayName": null,
      "resourceDisplayName": "CORP_DBUM_MAIN",
      "permissionType": "Privilege",
      "cloudAccount": null,
      "domainName": null,
      "isBundle": false,
      "expirationTime": 0,
      "accessLimitType": null
    }
  ]
}
Back to Top