List Users With Search

Search for users based on the properties specified in the search parameter.

The input and output fields in this card are dynamically generated based on your instance.

Scopes

See Action cards for the list of required OAuth scopes needed by this card.

Options

Field	Definition	Type	Required
Result Set	Choose a method to filter search results: First Matching Record: Returns the first record that matches. First 200 Matching Records: Returns the first 200 matching records. Stream Matching Records: Passes all matching records from your parent flow to a helper flow. Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.	Dropdown	TRUE

Field

Definition

Type

Required

Result Set

Choose a method to filter search results:

First Matching Record: Returns the first record that matches.
First 200 Matching Records: Returns the first 200 matching records.
Stream Matching Records: Passes all matching records from your parent flow to a helper flow.

Selecting this option adds a Streaming input section to the card where you can select a helper flow for streaming and add custom extensible fields.

Dropdown

TRUE

To learn how to return a large number of records, see Stream matching records with a helper flow.

Input

Field	Definition	Type	Required
Status	Status of the Okta user: STAGED PROVISIONED ACTIVE RECOVERY LOCKED_OUT PASSWORD_EXPIRED SUSPENDED DEPROVISIONED	Dropdown	FALSE
Created	Date and time when the object was created.	Text	FALSE
Activated	Time stamp when the user was activated.	Text	FALSE
Status Changed	Time stamp when the user's status was changed.	Text	FALSE
Last Updated	Time stamp when the user was last updated.	Text	FALSE
ID	Unique ID of the user.	Text	FALSE
Username	User's username.	Text	FALSE
First Name	User's first name.	Text	FALSE
Last Name	User's last name.	Text	FALSE
Middle Name	User's middle name.	Text	FALSE
Honorific Prefix	User's honorific prefixes, also known as title in most Western languages.	Text	FALSE
Honorific Suffix	User's honorific suffixes, also known as title in most Western languages.	Text	FALSE
Primary Email	User's primary email address.	Text	FALSE
Title	Job title of the user.	Text	FALSE
Display Name	User's display name.	Text	FALSE
Nickname	User's nickname.	Text	FALSE
Profile Url	URL of the user's online profile or a web page.	Text	FALSE
Secondary Email	User's secondary email.	Text	FALSE
Mobile Phone	User's mobile phone number.	Text	FALSE
Primary Phone	User's primary phone number.	Text	FALSE
Street Address	Full street address component of user's address.	Text	FALSE
City	City or locality component of the user's address.	Text	FALSE
State	State or region component of the user's address.	Text	FALSE
Zip Code	Zip code or postal code component of the user's address.	Text	FALSE
Country Code	Country abbreviation.	Text	FALSE
Postal Address	Mailing address component of user's address.	Text	FALSE
Preferred Language	User's preferred written or spoken languages.	Text	FALSE
Locale	User's default location for purposes of localizing items like currency, date/time format, and numerical representations.	Text	FALSE
Time Zone	User's time zone.	Text	FALSE
User Type	Relationship to the user to the organization, such as Employee or Contractor.	Text	FALSE
Employee Number	The user's organization- or company-assigned unique ID.	Text	FALSE
Cost Center	The name of a cost center assigned with the user.	Text	FALSE
Organization	Name of the user's organization.	Text	FALSE
Division	Name of the user's division.	Text	FALSE
Department	Name of user's department.	Text	FALSE
ManagerId	ID of the user's manager.	Text	FALSE
Manager	The display name of the user's manager.	Text	FALSE
Custom String 1	Custom string.	Text	FALSE
Custom String Enum	Custom string enumerator.	Dropdown	FALSE
Custom Search Criteria	Any custom search criteria that you want to add. See Okta Developer documentation.	Text	FALSE
Sort
Sort by	Choose from the options available.	Dropdown	FALSE
Sort Order	Choose from ASC or DESC.	Dropdown	FALSE
Streaming
Flow	Click Choose Flow to browse and select a helper flow where the search results will be streamed, and then click Choose to confirm. Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow. Appears when Stream Matching Records is selected from the Result Set option.	Flow	TRUE
Search Criteria
Record Limit	Specify the number of records to stream. When the field is set to less than 0, the card returns an error. When the field is set to either 0 or a value greater than 0, the stream returns up to the maximum number specified. When the field is empty, null, or not selected, the stream returns all records. The default value is 1000000 (1 million). The valid range is from 0 to 1000000. This field appears when you select Stream Matching Records from the Result Set option.	Number	FALSE

Output

Field	Definition	Type
Users	This output section appears when you select First 200 Matching Records from the Result Set option. Fields that appear under Users are helper fields.	List of Objects
Raw Output	Raw output returned by the Okta API.	Object
ID	Unique identifier of the user.	Text
Status	Current status of the user.	Text
Created	Date and time when the object was created.	Text
Activated	Time stamp when the user was activated.	Text
Status Changed	Time stamp when the user's status was changed.	Text
Last Login	Time stamp when the user last logged in.	Text
Last Updated	Time stamp when the user was last updated.	Text
Password Changed	Time stamp when the user's password was changed.	Text
First Name	First name of the user.	Text
Last Name	Last name of the user.	Text
Mobile Phone	The mobile phone number of the user.	Text
Second Email	Secondary email of the user.	Text
Login	The user's sign-in username. This is usually in the form of an email address.	Text
Email	Email address of the user.	Text
Records Streamed	Number of records streamed in a streaming flow. Appears when Stream Matching Records is selected from the Result Set field.	Number

List Users With Search

Scopes

Options

Input

Output

Related topics