- 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.
curl -i -X GET \
'https://okta-subdomain.pixtulate.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
- Get campaign by id that is in scheduled state. |tooltip| Get the campaign by Id that is in scheduled state
- Get campaign by id that is in launching state. |tooltip| Get the campaign by Id that is in launching state
- Get campaign by id that is in error state. |tooltip| Get the campaign by Id that is in error state.
- Get recurring campaign details in scheduled state. |tooltip| Returns recurring campaign details. If the campaign is still in scheduled status, then expect to get recurring campaign schedule.
- Get the launched recurring campaign instance. |tooltip| Returns launched recurring campaign instance. Consider this campaign as a child of parent recurring campaign. This campaign instance is either launched as per schedule or manually.
- Get the campaign with group owners as reviewers |tooltip| Returns a campaign containing reviewers as owners of the groups under reviewer
- Get the campaign with reviewer group |tooltip| Returns a campaign having reviewers from a group. All the members of the group will be reviewers of any reviews created from this campaign.
- Get the campaign of multi level |tooltip| Returns a campaign having level 1 reviewer being a group and level 2 being a user. Reviews will move from level 1 to level 2 to get the final decision.
- Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.
- Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).
- Campaign with ramp entitlements enabled |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).
{ "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": { … } } }