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.

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

To learn how to return large numbers 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.

Text

FALSE

ID

Unique ID of the user.

Text

FALSE

Login

The user's sign-in username. This is usually in the form of an email address.

Text

FALSE

Email

Primary email address of the user.

Text

FALSE

First Name

First name of the user.

Text

FALSE

Last Name

Last name of the user.

Text

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". Replace value1 and value2 with specific values for the First Name and Email fields, respectively.
  • For examples of custom filters, see Filter Examples.

Text

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.

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 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

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

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 option.

Number

Related topics

Okta connector

Workflow elements

Guidance for Okta connector

Okta API documentation