Class GroupsResource.MembershipsResource

The "memberships" collection of methods.

Inheritance

object

GroupsResource.MembershipsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudIdentity.v1

Assembly: Google.Apis.CloudIdentity.v1.dll

Syntax

public class GroupsResource.MembershipsResource

Constructors

MembershipsResource(IClientService)

Constructs a new resource.

Declaration

public MembershipsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

CheckTransitiveMembership(string)

Check a potential member for membership in 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. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.

Declaration

public virtual GroupsResource.MembershipsResource.CheckTransitiveMembershipRequest CheckTransitiveMembership(string parent)

Parameters

Type	Name	Description
string	parent	Resource name of the group to check the transitive membership in. Format: groups/{group}, where group is the unique id assigned to the Group to which the Membership belongs to.

Returns

Type	Description
GroupsResource.MembershipsResource.CheckTransitiveMembershipRequest

Create(Membership, string)

Creates a Membership.

Declaration

public virtual GroupsResource.MembershipsResource.CreateRequest Create(Membership body, string parent)

Parameters

Type	Name	Description
Membership	body	The body of the request.
string	parent	Required. The parent Group resource under which to create the Membership. Must be of the form groups/{group}.

Returns

Type	Description
GroupsResource.MembershipsResource.CreateRequest

Delete(string)

Deletes a Membership.

Declaration

public virtual GroupsResource.MembershipsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the Membership to delete. Must be of the form groups/{group}/memberships/{membership}

Returns

Type	Description
GroupsResource.MembershipsResource.DeleteRequest

Get(string)

Retrieves a Membership.

Declaration

public virtual GroupsResource.MembershipsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the Membership to retrieve. Must be of the form groups/{group}/memberships/{membership}.

Returns

Type	Description
GroupsResource.MembershipsResource.GetRequest

GetMembershipGraph(string)

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.

Declaration

public virtual GroupsResource.MembershipsResource.GetMembershipGraphRequest GetMembershipGraph(string parent)

Parameters

Type	Name	Description
string	parent	Required. Resource name of the group to search transitive memberships in. Format: groups/{group}, where group is the unique ID assigned to the Group to which the Membership belongs to. group can be a wildcard collection id "-". When a group is specified, the membership graph will be constrained to paths between the member (defined in the query) and the parent. If a wildcard collection is provided, all membership paths connected to the member will be returned.

Returns

Type	Description
GroupsResource.MembershipsResource.GetMembershipGraphRequest

List(string)

Lists the Memberships within a Group.

Declaration

public virtual GroupsResource.MembershipsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/{group}.

Returns

Type	Description
GroupsResource.MembershipsResource.ListRequest

Lookup(string)

Looks up the resource name of a Membership by its EntityKey.

Declaration

public virtual GroupsResource.MembershipsResource.LookupRequest Lookup(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent Group resource under which to lookup the Membership name. Must be of the form groups/{group}.

Returns

Type	Description
GroupsResource.MembershipsResource.LookupRequest

ModifyMembershipRoles(ModifyMembershipRolesRequest, string)

Modifies the MembershipRoles of a Membership.

Declaration

public virtual GroupsResource.MembershipsResource.ModifyMembershipRolesRequest ModifyMembershipRoles(ModifyMembershipRolesRequest body, string name)

Parameters

Type	Name	Description
ModifyMembershipRolesRequest	body	The body of the request.
string	name	Required. The resource name of the Membership whose roles are to be modified. Must be of the form groups/{group}/memberships/{membership}.

Returns

Type	Description
GroupsResource.MembershipsResource.ModifyMembershipRolesRequest

SearchDirectGroups(string)

Searches direct groups of a member.

Declaration

public virtual GroupsResource.MembershipsResource.SearchDirectGroupsRequest SearchDirectGroups(string parent)

Parameters

Type	Name	Description
string	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.

Returns

Type	Description
GroupsResource.MembershipsResource.SearchDirectGroupsRequest

SearchTransitiveGroups(string)

Search transitive groups of a member. 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. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.

Declaration

public virtual GroupsResource.MembershipsResource.SearchTransitiveGroupsRequest SearchTransitiveGroups(string parent)

Parameters

Type	Name	Description
string	parent	Resource name of the group to search transitive memberships in. Format: groups/{group}, where group is always '-' as this API will search across all groups for a given member.

Returns

Type	Description
GroupsResource.MembershipsResource.SearchTransitiveGroupsRequest

SearchTransitiveMemberships(string)

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.

Declaration

public virtual GroupsResource.MembershipsResource.SearchTransitiveMembershipsRequest SearchTransitiveMemberships(string parent)

Parameters

Type	Name	Description
string	parent	Resource name of the group to search transitive memberships in. Format: groups/{group}, where group is the unique ID assigned to the Group.

Returns

Type	Description
GroupsResource.MembershipsResource.SearchTransitiveMembershipsRequest