Oracle Access Governance REST APIs

Get insights for an access review

get

/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/insights

Returns insights of the access review for a given accessReviewId.

Request

Path Parameters

accessReviewId(required): string

Unique access review identifier.

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 access review insights.

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 : AccessReviewInsights

Type: object

The insight information for the given access review.

Show Source

alignments: array alignments

The list of alignment information.
identityCollectionMembership: object IdentityCollectionMembership

The count for members in the identity collection.
insights: array insights

The list of insights.
locationAlignments: array locationAlignments

The list of location alignment information.
peerSimilarities: array peerSimilarities

The list of peer similarities information.
textualExplanations: array textualExplanations

The list of textual explanation.
version(required): integer

The version of the insights format.

{
    "type":"object",
    "description":"The insight information for the given access review.",
    "required":[
        "version"
    ],
    "properties":{
        "version":{
            "type":"integer",
            "description":"The version of the insights format."
        },
        "alignments":{
            "type":"array",
            "description":"The list of alignment information.",
            "items":{
                "$ref":"#/definitions/Alignment"
            }
        },
        "insights":{
            "type":"array",
            "description":"The list of insights.",
            "items":{
                "$ref":"#/definitions/InsightAttribute"
            }
        },
        "locationAlignments":{
            "type":"array",
            "description":"The list of location alignment information.",
            "items":{
                "$ref":"#/definitions/LocationAlignment"
            }
        },
        "peerSimilarities":{
            "type":"array",
            "description":"The list of peer similarities information.",
            "items":{
                "$ref":"#/definitions/PeerSimilarity"
            }
        },
        "identityCollectionMembership":{
            "$ref":"#/definitions/IdentityCollectionMembership"
        },
        "textualExplanations":{
            "type":"array",
            "description":"The list of textual explanation.",
            "items":{
                "$ref":"#/definitions/TextualExplanation"
            }
        }
    }
}

Nested Schema : alignments

Type: array

The list of alignment information.

Show Source

Array of: object Alignment

The alignment information for the given Identity Collection.

{
    "type":"array",
    "description":"The list of alignment information.",
    "items":{
        "$ref":"#/definitions/Alignment"
    }
}

Nested Schema : IdentityCollectionMembership

Type: object

The count for members in the identity collection.

Show Source

current(required): integer

The current member count in the identity collection.
expected(required): integer

The expected member count in the identity collection.

{
    "type":"object",
    "required":[
        "current",
        "expected"
    ],
    "properties":{
        "current":{
            "type":"integer",
            "description":"The current member count in the identity collection."
        },
        "expected":{
            "type":"integer",
            "description":"The expected member count in the identity collection."
        }
    },
    "description":"The count for members in the identity collection."
}

Nested Schema : insights

Type: array

The list of insights.

Show Source

Array of: object InsightAttribute

The insight attribute

{
    "type":"array",
    "description":"The list of insights.",
    "items":{
        "$ref":"#/definitions/InsightAttribute"
    }
}

Nested Schema : locationAlignments

Type: array

The list of location alignment information.

Show Source

Array of: object LocationAlignment

The alignment information for the given Identity Collection based on a location

{
    "type":"array",
    "description":"The list of location alignment information.",
    "items":{
        "$ref":"#/definitions/LocationAlignment"
    }
}

Nested Schema : peerSimilarities

Type: array

The list of peer similarities information.

Show Source

Array of: object PeerSimilarity

The list of peer similarities information

{
    "type":"array",
    "description":"The list of peer similarities information.",
    "items":{
        "$ref":"#/definitions/PeerSimilarity"
    }
}

Nested Schema : textualExplanations

Type: array

The list of textual explanation.

Show Source

Array of: object TextualExplanation

Textual explanation of review recommendation

{
    "type":"array",
    "description":"The list of textual explanation.",
    "items":{
        "$ref":"#/definitions/TextualExplanation"
    }
}

Nested Schema : Alignment

Type: object

The alignment information for the given Identity Collection.

Show Source

type(required): string

Allowed Values: [ "SAME_MANAGER", "SAME_JOB_CODE", "SAME_ORGANIZATION", "DIRECT_REPORT" ]

The value of the alignment
value(required): integer

The percentage value of the alignment

{
    "type":"object",
    "required":[
        "type",
        "value"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"The value of the alignment",
            "enum":[
                "SAME_MANAGER",
                "SAME_JOB_CODE",
                "SAME_ORGANIZATION",
                "DIRECT_REPORT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AlignmentType"
        },
        "value":{
            "type":"integer",
            "description":"The percentage value of the alignment"
        }
    },
    "description":"The alignment information for the given Identity Collection."
}

Nested Schema : InsightAttribute

Type: object

The insight attribute

Show Source

priority: integer

The priority of the insight attribute
type(required): string

Allowed Values: [ "RECOMMENDATION", "ANALYSIS_RESULT", "RECENT_CHANGE" ]

The type of the insight attribute
value(required): string

The value of the insight attribute

{
    "type":"object",
    "required":[
        "type",
        "value"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"The type of the insight attribute",
            "enum":[
                "RECOMMENDATION",
                "ANALYSIS_RESULT",
                "RECENT_CHANGE"
            ],
            "x-obmcs-top-level-enum":"#/definitions/InsightAttributeType"
        },
        "value":{
            "type":"string",
            "description":"The value of the insight attribute"
        },
        "priority":{
            "type":"integer",
            "description":"The priority of the insight attribute"
        }
    },
    "description":"The insight attribute"
}

Nested Schema : LocationAlignment

Type: object

The alignment information for the given Identity Collection based on a location

Show Source

locationScores: array locationScores

The scores per location for this alignment type
type(required): string

Allowed Values: [ "SAME_MANAGER", "SAME_JOB_CODE", "SAME_ORGANIZATION", "DIRECT_REPORT" ]

The value of the alignment

{
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"The value of the alignment",
            "enum":[
                "SAME_MANAGER",
                "SAME_JOB_CODE",
                "SAME_ORGANIZATION",
                "DIRECT_REPORT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AlignmentType"
        },
        "locationScores":{
            "type":"array",
            "description":"The scores per location for this alignment type",
            "items":{
                "$ref":"#/definitions/LocationScore"
            }
        }
    },
    "description":"The alignment information for the given Identity Collection based on a location"
}

Nested Schema : locationScores

Type: array

The scores per location for this alignment type

Show Source

Array of: object LocationScore

The alignment score for the given location

{
    "type":"array",
    "description":"The scores per location for this alignment type",
    "items":{
        "$ref":"#/definitions/LocationScore"
    }
}

Nested Schema : LocationScore

Type: object

The alignment score for the given location

Show Source

location(required): string

The location for the score
matchedCount(required): integer

The matched count of peers for the location
totalCount(required): integer

The total count of peers for the location
value(required): integer

The percentage value for the alignment score for the location

{
    "type":"object",
    "required":[
        "location",
        "matchedCount",
        "totalCount",
        "value"
    ],
    "properties":{
        "location":{
            "type":"string",
            "description":"The location for the score"
        },
        "matchedCount":{
            "type":"integer",
            "description":"The matched count of peers for the location"
        },
        "totalCount":{
            "type":"integer",
            "description":"The total count of peers for the location"
        },
        "value":{
            "type":"integer",
            "description":"The percentage value for the alignment score for the location"
        }
    },
    "description":"The alignment score for the given location"
}

Nested Schema : PeerSimilarity

Type: object

The list of peer similarities information

Show Source

similarities(required): array similarities

The list of similarities for this alignment type
type(required): string

Allowed Values: [ "SAME_MANAGER", "SAME_JOB_CODE", "SAME_ORGANIZATION", "DIRECT_REPORT" ]

The value of the alignment

{
    "type":"object",
    "required":[
        "similarities",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"The value of the alignment",
            "enum":[
                "SAME_MANAGER",
                "SAME_JOB_CODE",
                "SAME_ORGANIZATION",
                "DIRECT_REPORT"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AlignmentType"
        },
        "similarities":{
            "type":"array",
            "description":"The list of similarities for this alignment type",
            "items":{
                "$ref":"#/definitions/Similarity"
            }
        }
    },
    "description":"The list of peer similarities information"
}

Nested Schema : similarities

Type: array

The list of similarities for this alignment type

Show Source

Array of: object Similarity

The similarity information

{
    "type":"array",
    "description":"The list of similarities for this alignment type",
    "items":{
        "$ref":"#/definitions/Similarity"
    }
}

Nested Schema : Similarity

Type: object

The similarity information

Show Source

individual(required): number(float)

The percentage of individuals with similarity to their peers
location(required): string

The location for the score
peerCount(required): integer

the count of the peers for the location
peers(required): number(float)

The average similarity percentage of peers

{
    "type":"object",
    "required":[
        "individual",
        "location",
        "peerCount",
        "peers"
    ],
    "properties":{
        "location":{
            "type":"string",
            "description":"The location for the score"
        },
        "individual":{
            "type":"number",
            "format":"float",
            "description":"The percentage of individuals with similarity to their peers"
        },
        "peers":{
            "type":"number",
            "format":"float",
            "description":"The average similarity percentage of peers"
        },
        "peerCount":{
            "type":"integer",
            "description":"the count of the peers for the location"
        }
    },
    "description":"The similarity information"
}

Nested Schema : TextualExplanation

Type: object

Textual explanation of review recommendation

Show Source

attributes(required): array attributes

Maximum Number of Items: 4

Attributes of textual explanation
explanation(required): string

Textual explanation

{
    "type":"object",
    "description":"Textual explanation of review recommendation",
    "required":[
        "explanation",
        "attributes"
    ],
    "properties":{
        "explanation":{
            "type":"string",
            "description":"Textual explanation"
        },
        "attributes":{
            "type":"array",
            "description":"Attributes of textual explanation",
            "items":{
                "type":"string"
            },
            "maxItems":4
        }
    }
}

Nested Schema : attributes

Type: array

Maximum Number of Items: 4

Attributes of textual explanation

Show Source

Array of: string

{
    "type":"array",
    "description":"Attributes of textual explanation",
    "items":{
        "type":"string"
    },
    "maxItems":4
}

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 insights for a given access review task. The accessReviewId path parameter is mandatory.

cURL Example

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

Example of the Response Body

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

{
    "version": 3,
    "alignments": null,
    "insights": null,
    "locationAlignments": null,
    "peerSimilarities": [
        {
            "type": "SAME_MANAGER",
            "name": null,
            "similarities": null
        },
        {
            "type": "SAME_JOB_CODE",
            "name": null,
            "similarities": null
        },
        {
            "type": "SAME_ORGANIZATION",
            "name": null,
            "similarities": null
        }
    ],
    "identityCollectionMembership": null,
    "textualExplanations": [
        {
            "explanation": "This identity has no peers across <strong>all</strong> locations with the same: ",
            "attributes": ["Job code"]
        }
    ]
}