How to List Group Members via Okta API
Last Updated:
Overview
Administrators can list group members by executing a specific API call. This process requires an API client configured for the Okta organization environment and the Okta Groups API collection.
Applies To
- Okta Identity Engine (OIE)
- Okta Classic Engine
- API
- Groups API
Solution
The following prerequisites are required to list group members.
Administrators must configure an API client for the organization environment. An example of an API client is Postman, but administrators should use a tool that best fits the organization's guidelines. Configure the API client as described in the Test the Okta REST APIs using Postman article and import the Okta Groups API Collection into the API client.
To list group members in a group, follow the steps or video below.
How are group members listed using the API?
Configure the API client, import the required collection, and execute the API call to retrieve the group members.
- Set up the API client as described in the Test the Okta REST APIs using Postman article.
- Import the Okta Groups Collection found on the Okta Groups API Collection Okta developer page.
- Prepare the List Group Users call and select Send.
- Verify that the response returns a 200 OK status and includes all user data for the tenant. Administrators can convert this data into a Comma-Separated Values (CSV) format using a converter.
