Guide on Using the Okta Identity Governance APIs
Last Updated:
Okta Identity Governance provides API documentation that includes endpoint syntax, expandable request and response details, and sample code for common use cases. The documentation page looks static at first, but hidden controls expose examples, layouts, and request samples that help with testing and implementation. Familiarity with these controls makes it easier to explore Governance endpoints and reuse example syntax.
Applies To
- Okta Identity Engine (OIE)
- Okta Identity Governance API
- API documentation
- Governance endpoints
- Request types
The Okta Identity Governance API documentation exposes interactive examples
Okta provides APIs for Governance. The API documentation for Identity Governance includes Governance-related endpoints, expandable sections, and example outputs for common use cases.
The same documentation also links to an example workflow article: How to Create a Request Type article.
Open the documentation page, expand Request Types, select Create a request type, and open the caret-controlled sections to view request and response details.
- Visit the API documentation for Identity Governance.
- Select Request Types in the left menu to expand the available API endpoints.
- Select Create a request type.
- Select the caret-controlled sections in the page content to expand or collapse details.
- Review the expanded request type details.
How do the documentation layout controls change the sample display?
The layout controls change how the page displays request and response samples. Each control exposes the same reference content differently, which helps with either compact browsing or detailed review.
| Minimized View | Show Samples View | Change Layout Maximized View |
|---|---|---|
Review the available layout controls to understand how each one presents sample data.
- Minimized View shows the breakdown of the API and its components, but does not show sample data.
- Show Samples View displays a small view of the API with samples on the right side of the page.
- Change Layout Maximized View expands the samples into a full-page view and moves them to the bottom of the section.
Show Samples View
Change Layout Maximized View moves the dark-colored examples from the right side of Show Samples View to the bottom of the section.
How are request samples and example code expanded?
The dark sample areas include additional caret controls that reveal request samples, example code, and use-case-specific syntax. Expanding these sections exposes deeper examples than the default page view shows.
Expand the dark sample sections, open Request samples, and review the example code and available use cases.
- Select the caret next to the section shown below to expand more details.
- Review the expanded details.
- Select the caret next to Request samples to expand or collapse the details under it.
- Open other dropdown sections that do not stand out in the initial view.
- Review the available examples and sample code.
How is use-case-specific syntax displayed for a request type?
Selecting a use case in the dropdown menu populates syntax that matches that selection. The generated example also includes controls to reuse or reorganize the sample content.
Select For access to group, requires manager’s approval in the dropdown menu to populate the matching syntax and expose the available sample controls.
- Select For access to group, requires manager’s approval in the dropdown menu.
- Review the populated syntax below the dropdown menu.
- Use Copy, Expand all, or Collapse all to work with the generated example code.
The same examples support testing for Okta Identity Governance API use cases. For an Okta Workflows example that creates a request type, use here.
To view feature requests and upvote product enhancement requests, please visit Okta Ideas.
Looking for Okta Identity Governance help? Visit the Okta Identity Governance Product Hub or schedule Office Hours with the Okta Identity Governance team.
