Skip to content
Okta Identity Governance
/
Management APIs
/
/
Generate a summary for a...

Generate a summary for a security access review

Request

OAuth 2.0 scope:
  • okta.governance.securityAccessReviews.admin.manage
Admin roles:
  • SUPER_ADMIN
Permissions:
  • okta.governance.securityAccessReviews.admin.manage

Generates a summary for a security access review

Notes:

  • The governanceAI.securityAccessReview.enabled org governance setting must be enabled for users to generate summaries for security access reviews.
  • This feature is excluded from the Okta for AI Agents - Core SKU, which is the version of Okta for AI Agents available to FedRAMP Moderate and FedRAMP High customers. Okta for AI Agents - Core isn't available in Okta for US Military cells. For a current list of features that are excluded from the Okta for AI Agents - Core SKU, please refer to the Okta US Public Sector Limitations or Exceptions documentation.
Path
securityAccessReviewIdstringrequired

The ID of the security access review

POST
/governance/api/v2/security-access-reviews/{securityAccessReviewId}/summary
curl -i -X POST \
  'https://okta-subdomain.pixtulate.com/governance/api/v2/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"
}