Search Users

Search users in Databricks.

Options

Field	Definition	Type	Required
Result Set	Choose one of the following options to display your results: `First Matching Record:` Returns only the first record that matches the search and sort criteria. `First 100 Matching Records:` Returns the first 100 records that match the search and sort criteria. `Stream Matching Records:` Passes all records that match the search criteria 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
Filter Type	Operators to be used when filtering search results. `Contains:` The selected attributes contain the provided values. `Equal:` The selected attributes are equal to the provided values. `Not Equal:` The selected attributes aren't equal to the provided values. `Starts With:` The selected attributes start with the provided values.	Dropdown	TRUE

Note:

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

Input

Field	Definition	Type	Required
Search By
User Name	Username of the user.	Text	FALSE
Email	The email address of the user.	Text	FALSE
Full Name	Full name of the user.	Text	FALSE
Custom Filter
Filter	Add the custom filter query to enhance the search. If the Custom Filter field is used with other input fields, its value must start with `and`, or `or` logical operator. If the Custom Filter field is used without any input fields, its value can't start with `and`, or `or` logical operator. To know the full list of available attributes and filter operators, see Databricks List Users API.	Text	FALSE
Sort
Sort Order	The order to sort the results: `Ascending` `Descending`	Dropdown	FALSE
Sort By	Attribute to sort the results by: `ID` `User Name` `Emails` `Display Name` `Active` `Roles`	Dropdown	FALSE
Streaming
Flow	Click Choose Flow to browse and select a helper flow for streaming search results, then click Choose to confirm. You can also optionally add custom fields to pass extra data to the helper flow: Click the empty field under Click or drop here to create section to add custom extensible fields that pass data to the helper flow. The custom extensible fields are added as key and value pairs under the State input object in the helper flow. The Flow field appears only when you select `Stream Matching Records` from the Result Set option. Note: The input field for the Helper card within the streaming helper flow should reference the Record key (object type) to successfully pull streamed records. To retrieve state input values, ensure you reference the State key (object type).	Flow	TRUE
Record Limit	Specify the number of records to stream. When the Record Limit is greater than 1, 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 `500000`. The valid range is from `1` to `500000`. This field appears only when you select `Stream Matching Records` from the Result Set option.	Number	FALSE

Output

Field	Definition	Type
Result
ID	Unique identifier of the user.	Text
User Name	Username of the user.	Text
Primary Email	Primary email address of the user.	Text
Emails	All the emails associated with the user.	List of Objects
Type	Type of the email. Example: work.	Text
Value	The email address of the user.	Text
Primary	Specifies whether the email address is primary (true) or not (false).	True/False
Full Name	Full name of the user.	Text
First Name	First name of the user.	Text
Last Name	Last name of the user.	Text
Is Account Admin	Specifies whether the user is an Account Admin (true) or not (false).	True/False
Is Active	Specifies whether the user is Active (true) or Inactive (false).	True/False
Raw Output	API returns the raw response body.	Object
Users	The search returns a list of up to 100 users that match the search and sort criteria. This list contains the output fields for each user as individual object. This field appears when you select the `First 100 Matching Records` from the Result Set option.	List of Objects
Records Streamed	The number of records streamed. This field appears when you select `Stream Matching Records` from the Result Set option.	Number

Related topics

Databricks connector

Databricks API Documentation