Skip to content
Okta Identity Governance
/
End user APIs
/
/
Submit a bulk-review deci...

Submit a bulk-review decision

Request

OAuth 2.0 scope:
  • okta.governance.reviewer.manage

Submits a decision for bulk reviews in a campaign. The request body includes the criteria used to select the reviews for applying the decision.

Path
campaignIdstringrequired

Unique identifier for the campaign

Bodyapplication/jsonrequired

Request body for submitting a decision for bulk reviews

criteriaobject(bulk-review-submission-criteria-mutable)required

The criteria for selecting reviews

reviewDecisionstring(bulk-review-decision)required

The decision applied to all reviews matching the bulk-review criteria

Value:"APPROVE"
reviewerLevelstring(reviewer-level-type)

Identifies the reviewer level of each reviews during access certification. Applicable for multi level campaigns only.

Enum:"FIRST""SECOND"
notesstring, [ 1 .. 300 ] characters

The reviewer's note to include with the bulk decision. This note is added to all reviews that match the bulk-review criteria.

POST
/governance/api/v1/my/campaigns/{campaignId}/reviews/bulk-decisions
curl -i -X POST \
  'https://okta-subdomain.pixtulate.com/governance/api/v1/my/campaigns/{campaignId}/reviews/bulk-decisions' \
  -H 'Content-Type: application/json' \
  -d '{
    "criteria": {
      "type": "GOVERNANCE_ANALYZER",
      "govAnalyzerCriteria": {
        "recommendedActionDecision": "APPROVE"
      }
    },
    "reviewDecision": "APPROVE"
  }'

Responses

Accepted response for a bulk-review submission

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
statusstring(bulk-review-decision-status-type)required

The bulk-review submission request status

Enum ValueDescription
ACCEPTED

Bulk-review decision submission has been accepted and is pending processing

IN_PROGRESS

Bulk-review decision submission is processing

COMPLETED

Bulk-review decision submission was processed and completed successfully

ERROR

Bulk-review decision submission ended with errors

eligibleReviewRecordCountinteger, (int32)required

The number of eligible reviews in the submission

jobIdstring, [ 1 .. 20 ] charactersrequired

The id of the job

Response
{
  "status": "ACCEPTED",
  "eligibleReviewRecordCount": 100,
  "jobId": "aae3l2XZ300xRq1rV0g3",
  "_links": {
    "self": { … },
    "bulkReviewDecisionStatus": { … },
    "reviewRecordsProcessed": { … }
  }
}