Use Okta APIs to List Users in a Group
Last Updated:
Overview
Administrators require a method to retrieve a list of users within a specific Okta group. Retrieve the group identifier using the Groups API, and then use the List Group Members API to generate the user list.
Applies To
- Okta Identity Engine (OIE)
- Okta Classic Engine
- Okta User API
- Okta Groups API
- API Client
Solution
In this video, learn how to use Okta APIs to list users in a group.
How are Okta APIs used to list users in a group?
Set up an API client, import the Okta Groups collection, retrieve the group identifier, and execute the API call to list the group members.
- Review the documentation for the chosen API client, such as Postman documentation, for setup instructions. Ensure the selected tool aligns with organizational guidelines.
- Import the Okta Groups collection into the API client.
- Search Groups by name using the following GET request:
GET {{url}}/api/v1/groups?q=NAME
- Retrieve the
groupIdfrom the API response. - List Group members using the following GET request:
GET /api/v1/groups/${groupId}/users
- Convert the API responses to a Comma-Separated Values (CSV) file using a preferred conversion method
