- okta.governance.accessCertifications.read
- ACCESS_CERTIFICATIONS_ADMIN
Retrieves the full representation of a specific campaign.
More information is returned than the abbreviated representation in a List campaigns operation.
- https://subdomain.okta.comhttps://subdomain.okta.com/governance/api/v1/campaigns/{campaignId}
curl -i -X GET \
'https://subdomain.okta.com/governance/api/v1/campaigns/{campaignId}'A successful campaign list response
The id of the Okta user who created the resource
The ISO 8601 formatted date and time when the resource was created
The ISO 8601 formatted date and time when the object was last updated
The id of the Okta user who last updated the object
Name of the campaign. Maintain some uniqueness when naming the campaign as it helps to identify and filter for campaigns when needed.
Identifies the campaign as a resource (RESOURCE) or an identity (USER) campaign
| Enum Value | Description |
|---|---|
| RESOURCE | Certify access to resources in a campaign |
| USER | Certify access for an identity (user or AI agent) in a campaign |
Scheduler specific settings.
A campaign can be a ONE_OFF or a RECURRING campaign.
You can't provide both in the campaign definition.
An array of Okta specific resource id for which access is being reviewed.
Reviewer settings for the access certification campaign
Settings for email notifications to be sent to the reviewers at different stages of a campaign. All properties are optional.
Specifies the action to be taken after a reviewer makes a decision to APPROVE or REVOKE the access, or if the campaign was CLOSED and there was no response from the reviewer
ID of the recurring campaign if this campaign was created as part of a recurring schedule.
Reporting properties for processing post-completed campaigns
The status of the campaign
| Enum Value | Description |
|---|---|
| SCHEDULED | The campaign is scheduled to launch at a future time. |
| LAUNCHING | The campaign is in the process of launching. |
| ACTIVE | The campaign is currently active and running. |
| COMPLETED | The campaign has completed its execution. |
| DELETED | The campaign has been deleted and is no longer available. |
| ERROR | An error occurred during the campaign's execution. |
| STAGING_ELIGIBLE | The campaign is eligible for staging. A campaign is eligible for staging between one and seven days before its scheduled start date. |
| STAGING_IN_PROGRESS | The campaign is currently being staged. |
| STAGING_READY | The campaign has been successfully staged and is ready for launch. |
| STAGING_FAILED | The staging process for the campaign has failed. |
| STAGING_OUTDATED | The staging information for the campaign is outdated and must be restaged. This typically happens when an admin modifies resource, user, or reviewer configurations while the campaign is in the |
Get the campaign by Id that is in scheduled state
{ "id": "ici2b0ozhrs1S9sVf0g4", "status": "SCHEDULED", "created": "2019-08-24T14:15:22Z", "createdBy": "00ub0oNGTSWTBKOLGLNR", "lastUpdated": "2019-08-24T14:15:22Z", "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR", "name": "Monthly access review of sales team", "description": "Review access of all sales team members to a specific app", "scheduleSettings": { "type": "ONE_OFF", "startDate": "2022-05-31T17:00:01.001-07:00", "endDate": "2022-06-29T17:00:01.001-07:00", "durationInDays": 30, "timeZone": "America/Los_Angeles" }, "resourceSettings": { "type": "GROUP", "targetResources": [ … ] }, "principalScopeSettings": { "type": "USERS", "userScope": { … } }, "reviewerSettings": { "type": "USER", "reviewerId": "00ub0oNGTSWTBKOLGLNR", "selfReviewDisabled": false }, "remediationSettings": { "accessApproved": "NO_ACTION", "accessRevoked": "DENY", "noResponse": "NO_ACTION" }, "_links": { "launchCampaign": { … }, "endCampaign": { … }, "campaignDetails": { … }, "reviews": { … }, "self": { … } } }