Search transitive memberships of a group.
Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned.
A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.
HTTP request
GET https://cloudidentity.googleapis.com/v1/{parent=groups/*}/memberships:searchTransitiveMemberships
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Resource name of the group to search transitive memberships in. Format: |
Query parameters
Parameters | |
---|---|
pageSize |
The default page size is 200 (max 1000). |
pageToken |
The nextPageToken value returned from a previous list request, if any. |
Request body
The request body must be empty.
Response body
The response message for MembershipsService.SearchTransitiveMemberships
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"memberships": [
{
object ( |
Fields | |
---|---|
memberships[] |
List of transitive members satisfying the query. |
nextPageToken |
Token to retrieve the next page of results, or empty if there are no more results. |
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.
MemberRelation
Message representing a transitive membership of a group.
JSON representation |
---|
{ "preferredMemberKey": [ { object ( |
Fields | |
---|---|
preferredMemberKey[] |
Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace. |
member |
Resource name for this member. |
roles[] |
The membership role details (i.e name of role and expiry time). |
relationType |
The relation between the group and the transitive member. |