<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M74D8PB" height="0" width="0" style="display:none;visibility:hidden">
Loading
Skip to NavigationSkip to Main Content
Create Access Certification Campaign with notificationSettings via API
Identity Governance
Okta Identity Engine
Overview

This article describes how to create a campaign via Postman with the Okta API call.

This is an optional step for customers who want to bypass the manual click action away from the Okta admin console UI.

Applies To
  • API (OAuth 2)
  • User Based Mode
  • Postman
  • Okta Identity Engine (OIE)
  • Okta Identity Governance
Solution

Prerequisites:

  • An Okta admin or developer will have to set up or configure the Postman app Environment with Okta org/tenant details prior.

NOTE: Okta does not recommend using the Okta-propriety SSWS API token authentication scheme. 

This API token scheme allows access to a broad range of APIs because there's no scope associated with the token. Access to the APIs depends on the privileges of the user who created the API token. The API token also has a fixed expiry date.

 

For more details, check here and start using the OAuth 2.0 Authorization Code grant flow instead:

  • Set up Okta for API access 
    1. Complete the following steps from the Developer docs:
      1. User-based API access setup
      2. Service-based API access setup
      3. Send a request
      4. Get an access token and make a request 

Then only make a request with an access token (generated from the User-based or Service-based API above) 

 

The call to Create a campaign is:

POST https://{yourOktaDomain}/governance/api/v1/campaigns

 

Or copy the exact API call from the Okta Dev page:

Campaigns

NOTE: Make sure that OktaDomainName is already pointed to the actual Okta URL to avoid "errorSummary": "Invalid token provided" error due to invalid URL.

 

When creating a campaign, specify the following:

  • Which resource(s) are subject to review.
  • Which user(s) with access to the resource(s) are subject to review.
  • The schedule of the campaign (ONE_OFF).
  • Who should review access.
  • What should be done after access is reviewed.
  • If notifications should automatically be sent to a campaign creator or reviewer.

Also, all those Request parameters have to be in the Raw format and input into the Postman Body section, see example:

Postman

  • Same thing again, copy the exact raw payload body from the Okta Dev page for testing purposes.

Last step, review all the above and double-check the payload, then hit the Send button to create the campaign.

This is the expected outcome with a 201 success code:

201 success code

Now, hop back onto the Admin Console page > OIG > Access Certification, the newly created or scheduled Campaign should be there:

Montly access review

 

Loading
Create Access Certification Campaign with notificationSettings via API