This article describes how to search for users using custom search criteria in Okta Workflows.
- Okta Workflows
The Okta – List Users with Search card has a Custom Search Criteria field. The Operators section lists the operators that can be used.
The Custom Search Criteria field uses the List all Users API search parameter. There is also a filter parameter, and the Okta – List Users with Filter card uses it.
- For best performance, it is recommended to use this parameter for search.
The API documents' search parameter lists properties that can be used in the search.
This operation searches many properties:
- Any user profile property, including custom-defined properties.
- The top-level properties
id,status,created,activated,statusChanged, andlastUpdated. - The User Type accessed as
type.id.
Examples
- This card, in this example, uses the
status eq “ACTIVE”search expression, which returns all the active users:
- The following examples search for either active or suspended users. The card will return users who are active and who are suspended:
- The following example uses the
properator and returns users who have theprofile.linkedInProfilefield with a non-empty value:
- The following examples search for users who were created before (
lt: less than) a specified date:
It might be noticed that the Last Login user field is unavailable when searching.
- The following example shows how to search using the Last Login field:
The List Users with Search card returns all users. The card passes the user list to the List—Filter card, which filters the list for users whose last login was before a specified date.
Related References
- Search Table by Date in Workflows
- Searching a Table Using a Custom Filter in Workflows
- How to Search a Card’s JSON Response in Workflows
- How To Search for Groups Using Custom Search Criteria in Workflows
