< Back
New-GoogleDirectoryGroup
Post
NAME New-GoogleDirectoryGroup
SYNOPSIS
Creates a new GSuite group.
SYNTAX
New-GoogleDirectoryGroup [-Email] <String> [-Name] <String> [[-Description] <String>] -BearerToken <String>
[-PassThru] [-UseCompression] [<CommonParameters>]
New-GoogleDirectoryGroup [-Email] <String> [-Name] <String> [[-Description] <String>] [-ProfileLocation <String>]
[-Persist] [-PassThru] [-UseCompression] [<CommonParameters>]
DESCRIPTION
This cmdlet creates a new GSuite group.
PARAMETERS
-Email <String>
The group's email address.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The group's display name.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
An optional description for the group.
Required? false
Position? 3
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 newly created 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:\\>$NewGroup = New-GoogleDirectoryGroup -Email examplegroup@google.com -Name "Example Group" -Description "A
new group" -ClientId $Id -PassThru -Persist
This example creates a new group and returns the newly created group details to the pipeline. 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
SYNOPSIS
Creates a new GSuite group.
SYNTAX
New-GoogleDirectoryGroup [-Email] <String> [-Name] <String> [[-Description] <String>] -BearerToken <String>
[-PassThru] [-UseCompression] [<CommonParameters>]
New-GoogleDirectoryGroup [-Email] <String> [-Name] <String> [[-Description] <String>] [-ProfileLocation <String>]
[-Persist] [-PassThru] [-UseCompression] [<CommonParameters>]
DESCRIPTION
This cmdlet creates a new GSuite group.
PARAMETERS
-Email <String>
The group's email address.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The group's display name.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
An optional description for the group.
Required? false
Position? 3
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 newly created 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:\\>$NewGroup = New-GoogleDirectoryGroup -Email examplegroup@google.com -Name "Example Group" -Description "A
new group" -ClientId $Id -PassThru -Persist
This example creates a new group and returns the newly created group details to the pipeline. 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