Search Users

Return the users associated with the current site.

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

Input

Field	Definition	Type	Required
Inputs
Filter Expression	The syntax for the filter expression is `field:operator:value`. Use commas to separate multiple fields, for example, `name:eq:tableau.user@example.com,siteRole:eq:viewer`. See Filtering expressions in Tableau.	Text	FALSE
Sort Expression	The syntax for the sort expression is `field:direction`. The value of direction is either `asc` or `desc`, for example, `lastLogin:desc,name:asc`. See Sorting expressions in Tableau.	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. This field appears when you select `Stream Matching Records` from the Result Set option.	Flow	TRUE
Record Limit	Specify the number of records to stream. When the `Record Limit` field is set to `0`, the card returns a `400 Bad Request` error. 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 or not selected, the stream returns all records. The default value is `1000000` (1 million). The valid range is from `1` to `1000000`. This field appears when you select `Stream Records` from the Result Set option.	Number	FALSE

Output

Field	Definition	Type
Result
Users	This field appears when you select `First 200 Matching Records` from the Result Set option.	List of Objects
ID	Unique identifier of the user.	Text
Name	Username of the user.	Text
Full Name	The full name of the user.	Text
Email	The email address of the user.	Text
Site Role	The site role that is assigned to the user.	Text
Auth Setting	The authentication type for the user.	Text
External Auth User ID	The ID stored in the single sign-on (SSO) system for Tableau Cloud. If the user isn't configured to use external authentication, this value is the empty string.	Text
Last Login	The time stamp of the user's last recorded sign-in activity. The value is returned as a date in UTC format (YYYY-MM-DDTHH:MM:SSZ).	Date & Time
Locale	The locale code of the user.	Text
Language	The language code of the user.	Text
Domain Name	If `SAML` is enabled, and the user was imported from Active Directory, then this field contains the user's Active Directory domain.	Text
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

Related topics

Tableau Cloud connector

Tableau Cloud API