Create a Custom Report Using Okta API Calls
Last Updated:
Overview
Administrators occasionally need to generate custom reports that are not available in the standard Okta Reports. Create a custom report by executing Okta API calls through Postman, handling pagination for large datasets, and converting the resulting JSON output into a CSV file for filtering.
Applies To
- Okta Identity Engine (OIE)
- Okta Classic Engine
- Reports
- Okta API
Solution
Configuring Postman is required to generate custom reports.
Configure Postman to interact with the Okta REST APIs and execute the necessary calls to retrieve the desired data.
- Configure Postman according to the developer documentation for the API. Refer to Get Started with the Okta REST APIs.
- Execute the API call to retrieve the data.
What is the process for handling pagination with large datasets?
Manage large datasets by utilizing cursor-based pagination to navigate through multiple sets of results.
- Requests that return a list of resources often support paging. Pagination relies on a cursor rather than page numbers. The cursor remains opaque to the client. Specify the cursor in either the
beforeorafterquery parameter. - Set a custom page size for specific resources using the
limitparameter.
NOTE: For technical reasons, not all APIs respect pagination or the before and limit parameters. Review the System Log API for examples.
Converting the JSON response into a CSV report completes the process.
Transform the JSON output from the API call into a structured CSV file using a web-based conversion tool.
- Copy the JSON response generated by the API call.
- Access a web-based JSON to CSV converter, such as Konklone.
- Download the resulting CSV file and filter the data as required. The conversion process changes attributes into columns and populates each row with a user.
