memberships_membership_graph
Creates, updates, deletes, gets or lists a memberships_membership_graph resource.
Overview
| Name | memberships_membership_graph |
| Type | Resource |
| Id | google.cloudidentity.memberships_membership_graph |
Fields
The following fields are returned by SELECT queries:
- get_membership_graph
Successful response
| Name | Datatype | Description |
|---|---|---|
name | string | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}. |
done | boolean | If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. |
error | object | The error result of the operation in case of failure or cancellation. (id: Status) |
metadata | object | Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
response | object | The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_membership_graph | select | groupsId | query | Get a membership graph of just a member or both a member and 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 member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
groupsId | string | |
query | string |
SELECT examples
- get_membership_graph
Get a membership graph of just a member or both a member and 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 member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the response will contain all membership paths between the group and the member.
SELECT
name,
done,
error,
metadata,
response
FROM google.cloudidentity.memberships_membership_graph
WHERE groupsId = '{{ groupsId }}' -- required
AND query = '{{ query }}';