Search Users

Search for Auth0 user information either through user properties or an email address.

Options

Field	Definition	Type	Required
Search By	Select an option for your user search: User Properties: You can perform a search against most user account attributes. You may need to repeat the search if the results don't reflect a recently completed write operation. See Search for Users. Email: Search for Auth0 users based on their email address. This option reflects the results of all successful write operations, even if they occurred immediately before the search request.	Dropdown	TRUE
Result Set	Choose one of the following options to display your search results: First Matching Record: Returns only the first record that matches the search query. First 100 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. Auth0 limits the number of users returned for searches. The Streaming option returns a maximum of 1000 users. If you exceed this threshold, redefine your search, or use the Auth0 export job, or the Auth0 User Import / Export extension.	Dropdown	TRUE

Field

Definition

Type

Required

Search By

Select an option for your user search:

User Properties: You can perform a search against most user account attributes. You may need to repeat the search if the results don't reflect a recently completed write operation. See Search for Users.
Email: Search for Auth0 users based on their email address. This option reflects the results of all successful write operations, even if they occurred immediately before the search request.

Dropdown

TRUE

Result Set

Choose one of the following options to display your search results:

First Matching Record: Returns only the first record that matches the search query.
First 100 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.

Auth0 limits the number of users returned for searches. The Streaming option returns a maximum of 1000 users. If you exceed this threshold, redefine your search, or use the Auth0 export job, or the Auth0 User Import / Export extension.

Dropdown

TRUE

Input

Field	Definition	Type	Required
User
Name	Name of the user. For the provided value, the Name input only returns users with an exact matching name.	Text	FALSE
ID	Unique identifier of the user.	Text	FALSE
Email	The email address of the user. If you select Email as the Search By option, then this is the only input field displayed under the User section.	Text	FALSE
Email Verified	Indicates whether this email address is verified or unverified. The user receives a verification email after creation if this is false or not specified.	True/False	FALSE
Phone Number	The user's phone number. The number format must follow the globalized E.164 recommendation of 12 characters, including the region code and area code. For example, +15559876543. This field is valid only for users with SMS connections.	Text	FALSE
Phone Verified	Indicates whether this phone number is verified or unverified.	True/False	FALSE
Given Name	Given name of the user.	Text	FALSE
Username	Username of the user.	Text	FALSE
Family Name	Last name of the user.	Text	FALSE
Nickname	Nickname of the user.	Text	FALSE
Blocked	Indicates whether an administrator has blocked this user or not.	True/False	FALSE
Identity User ID	User's unique ID for this connection or provider.	Text	FALSE
Identity Connection	Name of the Auth0 connection used to authenticate the user.	Text	FALSE
Identity Is Social	Indicates whether the connection is authenticated through a social provider.	True/False	FALSE
Identity Provider	Name of the entity that authenticated the user. For example, Facebook, Google, SAML, or your own provider.	Text	FALSE
Created At	A timestamp indicating when the user profile was initially created.	Text	FALSE
Updated At	A timestamp indicating when the user's profile was most recently updated or modified. Changes to Last Login are considered updates, so most of the time, Updated At matches Last Login.	Text	FALSE
Last Login	A timestamp indicating when the user last signed in.	Text	FALSE
Logins Count	Number of times the user has signed in.	Number	FALSE
Last IP	IP address associated with the user's last sign-in attempt.	Text	FALSE
Custom Filter	Provide a custom query to search for users. Searching by user properties uses Lucene query syntax. See User Search Query Syntax. While the primary use for this input is to search the Metadata and App Metadata fields of users, you can adapt this filter to query any properties. For example: (name:Jessie Doe) (name:Jessie Doe AND given_name:Jessie) (name:"Jane Doe" OR given_name:John OR identities.connection:auth0 AND user_metadata.color:blue AND app_metadata.score:100)	Text	FALSE
Streaming
Flow	Click Choose Flow to browse and select a helper flow as the destination for the streamed search results. Click Choose to confirm. Each user record triggers one execution of the flow. User data is referenced through the keys in the Record output object in the helper flow. Optionally, you can click the empty field under Click or drop here to create to add custom extensible fields that pass data to the helper flow. These fields are added as key and 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
Record Limit	Specify the number of records to stream. When the Record Limit field is set to 0, the stream returns no records. When the Record Limit field is set to greater than 0, the stream returns up to the maximum number specified. When the Record Limit field is empty, null, or not selected, the stream returns all records. The default value is 1000. The valid range is from 0 to 1000. This field appears when Stream Matching Records is selected from the Result Set option.	Number	FALSE

Output

Field	Definition	Type
Result
ID	Unique identifier of the user.	Text
Name	Name of the user.	Text
Email	The email address of the user.	Text
Email Verified	Indicates whether this email address is verified or unverified. The user receives a verification email after creation if this is false or not specified.	True/False
Phone Number	The user's phone number. This output value only appears for users with SMS connections.	Text
Phone Verified	Indicates whether this phone number is verified or unverified.	True/False
Metadata	Data related to the user that doesn't affect the application's core functionality.	Object
App Metadata	Data related to the user that does affect the application's core functionality.	Object
Username	Username of the user.	Text
Given Name	Given name of the user.	Text
Family Name	Last name of the user.	Text
Nickname	Nickname of the user.	Text
Picture	A uniform resource identifier (URI) containing the user's picture. For example, https://www.akc.org/wp-content/uploads/2017/11/Pomeranian-On-White-01.jpg	Text
Blocked	Indicates whether an administrator has blocked this user or not.	True/False
Created At	A timestamp indicating when the user profile was initially created.	Text
Updated At	A timestamp indicating when the user's profile was most recently updated or modified. Changes to Last Login are considered updates, so most of the time, Updated At matches Last Login.	Text
Multifactor	List of multifactor providers where the user is enrolled.	List of Objects
Last IP	IP address associated with the user's last sign-in attempt.	Text
Last Login	A timestamp indicating when the user last signed in.	Text
Logins Count	Number of times the user has signed in.	Number
Identities	Contains information retrieved from the Identity Provider that originally authenticates the user.	List of Objects
Connection	Name of the Auth0 connection used to authenticate the user.	Text
User ID	User's unique ID for this connection or provider.	Text
Provider	Name of the entity that authenticated the user. For example, Facebook, Google, SAML, or your own provider.	Text
Is Social	Indicates whether the connection is authenticated through a social provider.	True/False
Users	The search returns a list of up to 100 users that match the search criteria. This field appears when you select the First 100 Matching Records as the Result Set option. This list contains the output fields for each user as individual objects.	List of Objects
Records Streamed	Number of records streamed in a streaming flow. This field appears when you select Stream Matching Records from the Result Set option.	Number

Search Users

Options

Input

Output

Related topics