Search Groups

Return a list of groups on 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, userCount:lte:10,isLocal:eq:true.

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

Groups

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

List of Objects

ID

Unique identifier of the group.

Text

Name

Name of the group.

Text

Minimum Site Role

The minimum license and site role granted to group users who sign into this Tableau Cloud site.

Text

User Count

The number of users in the group.

Number

Domain Name

If the group was imported from Active Directory, this field contains the group's Active Directory domain.

If the group uses local authentication, the value of this field is local.

Text

Import

Each Import object contains a Domain Name, Site Role, and Grant License Mode.

For a local group that uses onLogin as its grant license mode, the Import object has a Domain Name of local.

There's no Import object in the response for any local group without a set grant license mode.

Object

Domain Name

If the group was imported from Active Directory, this field contains the group's Active Directory domain.

If the group uses local authentication, the value of this field is local.

Text

Site Role

For this group, the site role assigned to users who are granted a license automatically using the grant license mode.

Text

Grant License Mode

For this group, the mode for automatically applying licenses to group members.

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

Cards in flows

Tableau Cloud API