Class MembersResource

The "members" collection of methods.

Inheritance

object

MembersResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Admin.Directory.directory_v1

Assembly: Google.Apis.Admin.Directory.directory_v1.dll

Syntax

public class MembersResource

Constructors

MembersResource(IClientService)

Constructs a new resource.

Declaration

public MembersResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Delete(string, string)

Removes a member from a group.

Declaration

public virtual MembersResource.DeleteRequest Delete(string groupKey, string memberKey)

Parameters

Type	Name	Description
string	groupKey	Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
string	memberKey	Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.

Returns

Type	Description
MembersResource.DeleteRequest

Get(string, string)

Retrieves a group member's properties.

Declaration

public virtual MembersResource.GetRequest Get(string groupKey, string memberKey)

Parameters

Type	Name	Description
string	groupKey	Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
string	memberKey	Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.

Returns

Type	Description
MembersResource.GetRequest

HasMember(string, string)

Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the memberKey and groupKey must be entities in the same domain or an Invalid input error is returned. To check for nested memberships that include entities outside of the group's domain, use the checkTransitiveMembership() method in the Cloud Identity Groups API.

Declaration

public virtual MembersResource.HasMemberRequest HasMember(string groupKey, string memberKey)

Parameters

Type	Name	Description
string	groupKey	Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
string	memberKey	Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.

Returns

Type	Description
MembersResource.HasMemberRequest

Insert(Member, string)

Adds a user to the specified group.

Declaration

public virtual MembersResource.InsertRequest Insert(Member body, string groupKey)

Parameters

Type	Name	Description
Member	body	The body of the request.
string	groupKey	Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

Returns

Type	Description
MembersResource.InsertRequest

List(string)

Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see Troubleshoot error codes.

Declaration

public virtual MembersResource.ListRequest List(string groupKey)

Parameters

Type	Name	Description
string	groupKey	Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

Returns

Type	Description
MembersResource.ListRequest

Patch(Member, string, string)

Updates the membership properties of a user in the specified group. This method supports patch semantics.

Declaration

public virtual MembersResource.PatchRequest Patch(Member body, string groupKey, string memberKey)

Parameters

Type	Name	Description
Member	body	The body of the request.
string	groupKey	Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
string	memberKey	Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.

Returns

Type	Description
MembersResource.PatchRequest

Update(Member, string, string)

Updates the membership of a user in the specified group.

Declaration

public virtual MembersResource.UpdateRequest Update(Member body, string groupKey, string memberKey)

Parameters

Type	Name	Description
Member	body	The body of the request.
string	groupKey	Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
string	memberKey	Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.

Returns

Type	Description
MembersResource.UpdateRequest