< Back

Set-GoogleDirectoryGroup

Mon Jan 13, 2020 10:51 pm

NAME Set-GoogleDirectoryGroup



SYNOPSIS

Updates a GSuite group properties.





SYNTAX

Set-GoogleDirectoryGroup [-GroupKey] <String> [[-Email] <String>] [[-Name] <String>] [[-Description] <String>]

-BearerToken <String> [-PassThru] [-UseCompression] [<CommonParameters>]



Set-GoogleDirectoryGroup [-GroupKey] <String> [[-Email] <String>] [[-Name] <String>] [[-Description] <String>]

[-ProfileLocation <String>] [-Persist] [-PassThru] [-UseCompression] [<CommonParameters>]





DESCRIPTION

This cmdlet updates a GSuite group.





PARAMETERS

-GroupKey <String>

The unique Id of the group.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Email <String>

The group's new email address.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

The group's new display name.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Description <String>

An updated description for the group.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-BearerToken <String>

The bearer token to use to authenticate the request.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ProfileLocation <String>

The location where stored credentials are located. If this is not specified, the default location will be used.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Persist [<SwitchParameter>]

Indicates that the newly retrieved token(s) or refreshed token and associated client data like client secret

are persisted to disk.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

If specified, the updated group is passed to the pipeline.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-UseCompression [<SwitchParameter>]

If specified, the returned data is compressed using gzip.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None





OUTPUTS

None or System.Collections.Hashtable





NOTES





AUTHOR: Michael Haken

LAST UPDATE: 2/6/2018



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



PS C:\\>Set-GoogleDirectoryGroup -GroupKey NNN -Email updatedemail@google.com -ClientId $Id -Persist



Updates the group uniquely identified by NNN with a new email, updatedemail@google.com. The call is authenticated

with

an access token stored in a client profile, which is refreshed if necessary. Any updated tokens are persisted to

disk.











RELATED LINKS