Set GAGroupMember

Set-GAGroupMember

SYNOPSIS

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

SYNTAX

Set-GAGroupMember [-GroupName] <String> [-UserName] <String> [-Role] <GroupMembershipRoles>
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

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

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> Set-GAMembers -GroupKey $SomeGroupKeyString -MemberKey $SomeMemberKeyString -MemberBody $SomeMemberObj

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-GroupName

Email or immutable Id of the group. If Id, it should match with id of group object

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-UserName

Email or immutable Id of the user. If Id, it should match with id of member object

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 2
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-Role

Role of member

Possible values: MEMBER, MANAGER, OWNER

Type: GroupMembershipRoles
Parameter Sets: (All)
Aliases: 
Accepted values: MEMBER, MANAGER, OWNER

Required: True
Position: 3
Default value: MEMBER
Accept pipeline input: False
Accept wildcard characters: False

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-GAuthId

The GAuthId representing the gShell auth credentials this cmdlet should use to run.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

System.String

Email or immutable Id of the group. If Id, it should match with id of group object

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Directory API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]