Oracle Access Governance REST APIs

List Policy statement identities for the given policy statement

get

/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/policyStatements/{policyStatementId}/identities

Retrieves details of policy statement identities for the policy statement.

Request

Path Parameters

accessReviewId(required): string

Unique access review identifier.
policyStatementId(required): string

Unique policy statement identifier.

Query Parameters

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.
sortBy: string

The field to sort by. The default value is displayName.

Default Value: displayName

Allowed Values: [ "displayName", "domainName", "membership", "email" ]
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

The details of policy statement for given policy.

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.
opc-total-items: integer

The total number of items.

Root Schema : PolicyStatementIdentitySummaryCollection

Type: object

List of policy statement identity summaries.

Show Source

items(required): array items

List of policy statement identity summaries.

{
    "type":"object",
    "description":"List of policy statement identity summaries.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of policy statement identity summaries.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyStatementIdentitySummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of policy statement identity summaries.

Show Source

Array of: object PolicyStatementIdentitySummary

The policy statement identity associated with the given policy statement.

{
    "description":"List of policy statement identity summaries.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/PolicyStatementIdentitySummary"
    }
}

Nested Schema : PolicyStatementIdentitySummary

Type: object

The policy statement identity associated with the given policy statement.

Show Source

displayName: string

The display name of the policy identity.
domainName: string

The domainName that policy subject belongs to.
email: string

The policy statement identity email.
id(required): string

The id of the policy statement.
membership: string

The policy statement identity group name.
name(required): string

The user name of the policy identity.

{
    "type":"object",
    "description":"The policy statement identity associated with the given policy statement.",
    "required":[
        "id",
        "name"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the policy statement."
        },
        "name":{
            "description":"The user name of the policy identity.",
            "type":"string"
        },
        "displayName":{
            "description":"The display name of the policy identity.",
            "type":"string"
        },
        "domainName":{
            "description":"The domainName that policy subject belongs to.",
            "type":"string"
        },
        "membership":{
            "description":"The policy statement identity group name.",
            "type":"string"
        },
        "email":{
            "description":"The policy statement identity email.",
            "type":"string"
        }
    }
}

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 identities part of a policy statement in a policy access control review task. Use the Access Control review task id for a policy, policy statement id to retrieve resource count included in the policy.

cURL Example

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/access-reviews/accessReviews/${accessReviewId}/policyStatements/${policyStatementId}/identities

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "id": "globalId.OCI.488xxxx-xxxx-xxxx-xxxx-xxxxxx.3bxxxxxx",
      "name": "bill.clark@example.com",
      "displayName": "Bill Clark",
      "domainName": "Default",
      "membership": null,
      "email": "bill.clark@example.com"
    },
    {
      "id": "globalId.OCI.488xxxx-xxxx-xxxx-xxxx-xxxxxx.2exxxxxx",
      "name": "john.doe@example.com",
      "displayName": "John Doe",
      "domainName": "Default",
      "membership": null,
      "email": "john.doe@example.com"
    }
  ]
}