Search for Users with a Custom User Type
Last Updated:
Lifecycle Management
Administration
Okta Classic Engine
Okta Identity Engine
Overview
This article presents how to search for custom-type users in Okta Admin UI or via API.
Applies To
- Okta Admin User Interface (UI)
- Custom User Type
Solution
Okta Admin UI
- In the Okta Admin UI, navigate to Directory > People.
- Click Advanced Search, then click the X icon next to All user types.
- Choose the desired custom user type, then click Search. This will show all users of that user type.
Okta Users API
- Configure the Okta REST API client for the org. See the documents below for guidance:
- If using the recommended OAuth 2.0 and OIDC access tokens method, ensure the appropriate OAuth 2.0 scope is applied for each call.
- Make a GET call to List all user types with the
okta.userTypes.readscope and inspect the response to confirm the target type ID.- h
ttps://{OktaDomain}/api/v1/meta/types/user
- h
- Make a GET List All Users API call with the
okta.users.readscope and include the type ID in the Search along with any other parameters or search criteria to refine the results. This could look similar to the following:https://{OktaDomain}/api/v1/users?limit=200&search=type.id+eq+%22{userTypeId}%22
