Searches direct groups of a member.
HTTP request
GET https://cloudidentity.googleapis.com/v1beta1/{parent=groups/*}/memberships:searchDirectGroups
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Resource name of the group to search transitive memberships in. Format: groups/{group_id}, where group_id is always '-' as this API will search across all groups for a given member. |
Query parameters
Parameters | |
---|---|
query |
Required. A CEL expression that MUST include member specification AND label(s). Users can search on label attributes of groups. CONTAINS match ('in') is supported on labels. Identity-mapped groups are uniquely identified by both a Example query: |
page |
The default page size is 200 (max 1000). |
page |
The next_page_token value returned from a previous list request, if any. |
order |
The ordering of membership relation for the display name or email in the response. The syntax for this field can be found at https://cloud.google.com/apis/design/design_patterns#sorting_order. Example: Sort by the ascending display name: order_by="group_name" or order_by="group_name asc". Sort by the descending display name: order_by="group_name desc". Sort by the ascending group key: order_by="group_key" or order_by="group_key asc". Sort by the descending group key: order_by="group_key desc". |
Request body
The request body must be empty.
Response body
The response message for MembershipsService.SearchDirectGroups
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"memberships": [
{
object ( |
Fields | |
---|---|
memberships[] |
List of direct groups satisfying the query. |
next |
Token to retrieve the next page of results, or empty if there are no more results available for listing. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-identity.groups.readonly
https://www.googleapis.com/auth/cloud-identity.groups
https://www.googleapis.com/auth/cloud-identity
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
MembershipRelation
Message containing membership relation.
JSON representation |
---|
{ "membership": string, "roles": [ { object ( |
Fields | |
---|---|
membership |
The resource name of the Shall be of the form |
roles[] |
The |
group |
The resource name of the Shall be of the form |
group |
The |
display |
The display name of the |
labels |
One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. An object containing a list of |
description |
An extended description to help users determine the purpose of a |