Find Users

Search Okta users with a query. The query performs a starts with match against First Name, Last Name, or Email. Display the first record that matches, the first 200 matching records, or stream all matching records. See Find users.

Options

Field Definition Type Required
Result Set Choose a method to filter search results:
  • First Matching Record: returns a single record.
  • 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. A Streaming input section is added to the card from which you can select a helper flow for streaming and adding custom extensible fields.

 Dropdown TRUE
Tip

To learn how to return a large number of records, see Set up the stream matching option with a helper flow.

Input

Field Definition Type Required
Query Query string used to find records by first name, last name, or email address. For example, to search for Bob Ross, these query terms are valid: Bob, Ross, bob.ross@okta.com are all valid query terms. String FALSE
Streaming
Flow

Click Choose Flow to browse and select a helper flow where the search results will be streamed, 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.

This field appears when Stream Matching Records is selected from the Result Set field.

 Flow TRUE
Search Criteria      
Record Limit

Specify the number of records to stream.

  • When the Limit field is set to 0, no records are returned.

  • When the Limit field is set to greater than 0, records greater than 0 and up the maximum number of records specified are returned.

  • When the Limit field is empty or not selected, all records are streamed.

  • Default value is 10 million.

  • Valid range is 0 to 10 million.

Appears when Stream Matching Records is selected from the Result Set option.

 Number FALSE

Output

When selected from the Result Set option, both First Matching Record and First 200 Matching Records display the following fields unless otherwise stated.

Field Definition Type
Users This field appears when First 200 Matching Records is selected from Result Set field. Fields that appear under Users are helper fields. List of Objects
Raw Output Raw payload returned from the Okta API. Object
ID ID of the user created in Okta. String
Status Status of the user. A user profile can be one of the following:
  • STAGED

  • PROVISIONED

  • ACTIVE

  • RECOVERY

  • LOCKED_OUT

  • PASSWORD_EXPIRED

  • SUSPENDED

Tip

When the status of a user is set to deprovisioned, this card doesn't return parameters. Instead, use the Okta List Users with Search or List Users with Filter cards.

 String
Created Timestamp when the user was created. Date & Time
Activated Timestamp when the transition to ACTIVE status completed. Boolean
Status Changed Date of the last user status change. Date & Time
Last Login Timestamp of the user's last login date. Date & Time
Last Updated Timestamp of the user's last update. Date & Time
Password Changed Timestamp of the user's last password change. Date & Time
First Name First name of the user. String
Last Name User's last name or family name. String
Mobile Phone Mobile phone number of the user. String
Second Email Secondary email address of the user (typically used for account recovery). String
Login Login username of the user (usually in the form of an email address). String
Email Email address of the user.

This field appears when First 200 Matching Records is selected from Result Set field.

 String
Records Streamed Number of records streamed in a streaming flow.

This field appears when Stream Matching Records is selected from the Result Set field.

 Number

Related topics

Okta connector

About the elements of Okta Workflows

Okta API