Generate a summary for a security access review

Okta Identity Governance

End user APIs

Generate a summary for a security access review

Request

okta.governance.securityAccessReviews.endUser.manage

Generates a summary for a security access review

Note: The governanceAI.securityAccessReview.enabled org governance setting must be enabled for users to generate summaries for security access reviews.

Path

securityAccessReviewIdstringrequired

The ID of the security access review

POST

/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/summary

curl -i -X POST \
  'https://okta-subdomain.pixtulate.com/governance/api/v2/my/security-access-reviews/{securityAccessReviewId}/summary'

Responses

A successful security access review summary response

Headers

X-Rate-Limit-Limitinteger, >= 1required

The rate-limit ceiling for the current request

Example:60

X-Rate-Limit-Remaininginteger, >= 0required

The number of requests left for the current rate-limit window

Example:60

X-Rate-Limit-Resetinteger, >= 0required

The time when the rate limit resets, specified in UTC epoch time (in seconds)

Example:1609459200

Bodyapplication/json

messagestringrequired

Generated summary message

deltaMessagestring

Generated summary message as a delta (for streaming)

errorsArray of objects, [ 0 .. 100 ] items

Whenever summary generation has resulted in an error or blocked, the array of errors details the reasons

Response

{
  "message": "This app's overall priority is: High\nThe reasons why this app was assigned priority of High include:\n1. Usage history (HIGH): The user has not accessed this application in the last 90 days.\n2. Assignment method (HIGH): This user's assignment method differs from 75% of other users who have access to this application.\n"
}