GroupsSearchOptions
import type { GroupsSearchOptions } from "https://googleapis.deno.dev/v1/cloudidentity:v1.ts";
Additional options for CloudIdentity#groupsSearch.
§Properties
The maximum number of results to return. Note that the number of results
returned may be less than this value even if there are more available
results. To fetch all results, clients must continue calling this method
repeatedly until the response no longer contains a next_page_token
. If
unspecified, defaults to 200 for GroupView.BASIC
and 50 for
GroupView.FULL
. Must not be greater than 1000 for GroupView.BASIC
or
500 for GroupView.FULL
.
Required. The search query. * Must be specified in Common Expression
Language. * Must contain equality
operators on the parent, e.g. parent == 'customers/{customer_id}'
. The
customer_id
must begin with "C" (for example, 'C046psxkn'). [Find your
customer ID.] (https://support.google.com/cloudidentity/answer/10070793) *
Can contain optional inclusion operators on labels
such as
'cloudidentity.googleapis.com/groups.discussion_forum' in labels
). * Can
contain an optional equality operator on domain_name
. e.g. domain_name == 'examplepetstore.com'
* Can contain optional
startsWith/contains/equality
operators on group_key
, e.g.
group_key.startsWith('dev')
, group_key.contains('dev'), group_key == 'dev@examplepetstore.com'
* Can contain optional
startsWith/contains/equality
operators on display_name
, such as
display_name.startsWith('dev')
, display_name.contains('dev')
,
display_name == 'dev'