Version 4.0.24.10
Search groups include hierarchy
Returns all group records that match the given search criteria, and attaches
associated role_ids and parent group_ids.
If multiple search params are given and filter_or
is FALSE or not specified,
search params are combined in a logical AND operation.
Only rows that match all search param criteria will be returned.
If filter_or
is TRUE, multiple search params are combined in a logical OR operation.
Results will include rows that match any of the search criteria.
String search params use case-insensitive matching.
String search params can contain %
and '_' as SQL LIKE pattern match wildcard expressions.
example="dan%" will match "danger" and "Danzig" but not "David"
example="D_m%" will match "Damage" and "dump"
Integer search params can accept a single value or a comma separated list of values. The multiple
values will be combined under a logical OR operation - results will match at least one of
the given values.
Most search params can accept "IS NULL" and "NOT NULL" as special expressions to match
or exclude (respectively) rows where the column is null.
Boolean search params accept only "true" and "false" as values.
Request
GET
/groups/search/with_hierarchy
Expand HTTP Query definition...
fields
string
Requested fields.
limit
integer
Number of results to return (used with `offset`).
offset
integer
Number of results to skip before returning any (used with `limit`).
sorts
string
Fields to sort by.
filter_or
boolean
Combine given search criteria in a boolean OR expression
id
string
Match group id.
name
string
Match group name.
external_group_id
string
Match group external_group_id.
externally_managed
boolean
Match group externally_managed.
externally_orphaned
boolean
Match group externally_orphaned.
Response
200: Group
can
lock
object
Operations the current user is able to perform on this object
can_add_to_content_metadata
boolean
Group can be used in content access controls
contains_current_user
lock
boolean
Currently logged in user is group member
external_group_id
lock
string
External Id group if embed group
externally_managed
lock
boolean
Group membership controlled outside of Looker
include_by_default
lock
boolean
New users are added to this group by default
name
string
Name of group
user_count
lock
integer
Number of users included in this group
parent_group_ids
string[]
400: Bad Request
message
lock
string
Error details
documentation_url
lock
string
Documentation link
404: Not Found
message
lock
string
Error details
documentation_url
lock
string
Documentation link
429: Too Many Requests
message
lock
string
Error details
documentation_url
lock
string
Documentation link