List Users with Filter

List users in Okta based on the filter provided.

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

Filter parameters used with this card are case sensitive.

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
Tip

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
Last Updated Time stamp when the user was last updated. String FALSE
ID Unique ID of the user. String FALSE
Login Login username of the user (usually in the form of an email address). String FALSE
Email Primary email address of the user. String FALSE
First Name First name of the user. String FALSE
Last Name Last name or family name of the user. String FALSE
Custom Filter List users who match your custom filter. For example:
  • To list all staged users, use status eq "STAGED".
  • To list users based on First Name or Email, use profile.firstName eq "value1" or profile.email eq "value2" where value1 and value2 are specific values for a First Name and Email fields, respectively.
  • For examples of custom filters, see Filter Examples.
 String FALSE
Streaming
Flow Click Choose Flow to browse and select a helper flow to which 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.

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

 Flow FALSE
Search Criteria
Record Limit

Specify the number of records to stream.

  • When the Limit field is set to 0, the stream returns no records.

  • When the Limit field is set to greater than 0, the stream returns up to the maximum number specified.

  • When the Limit field is empty, null, or not selected, the stream returns all records.

  • The default value is 10000000 (10 million).

  • The valid range is 0 to 10000000.

This field appears when you select Stream Matching Records from the Result Set option.

 Number FALSE

Output

Field Definition Type
Raw Output Raw output returned by the Okta API. Object
ID Unique identifier of the user. String
Status Current status of the user. String
Created

Date and time when the object was created.

 String
Activated Timestamp when the user was activated. String
Status Changed Timestamp when the user's status was changed. String
Last Login Timestamp when the user last logged in. String
Last Updated Timestamp when the user was last updated. String
Password Changed Timestamp when the user's password was changed. String
First Name First name of the user. String
Last Name Last name or family name of the user. String
Mobile Phone Mobile phone number of the user. String
Second Email Secondary email of the user. String
Login Login username of the user (usually in the form of an email address). String
Email Email address of the user. String
Records Streamed Number of records streamed in a streaming flow.

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

 Number

Related topics

Okta connector

Workflow elements

Guidance for Okta connector

Okta API documentation