Set GShellServiceAccount

Set-GShellServiceAccount

SYNOPSIS

Set a service account for a Google Apps domain.

SYNTAX

Set-GShellServiceAccount [-Domain] <String> [-ServiceAccountId] <String> [-CertificatePath] <String>
 [[-KeyPassword] <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Set a service account for a Google Apps domain. A service account lets you run Cmdlets (that would otherwise be only for your own user) on behalf of a user in your domain. You must have domain administrator rights to use a service account. This will not work with Gmail accounts (unless maybe you work for Google).

EXAMPLES

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

PS C:\> Set-GShellServiceAccount -Domain $SomeDomainString -Email $SomeEmailString

This 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

-Domain

The domain the service account will represent and act upon. Do not include the @ symbol.

Type: String
Parameter Sets: (All)
Aliases: 

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

-ServiceAccountId

The full service account ID provided for the service account. This ID may look like an email address for a domain like 'gserviceaccount.com'.

Type: String
Parameter Sets: (All)
Aliases: 

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

-CertificatePath

The full system path to the service account key in json or P12 format. You were given this file when you created the service account.

Type: String
Parameter Sets: (All)
Aliases: 

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

-KeyPassword

The password for the key. If not provided defaults to 'notasecret' which is usually the case.

Type: String
Parameter Sets: (All)
Aliases: 

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

-Confirm

{{Fill Confirm Description}}

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

{{Fill WhatIf Description}}

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

INPUTS

System.String

The domain the service account will represent and act upon. Do not include the @ symbol.

System.String

The full service account ID provided for the service account. This ID may look like an email address for a domain like 'gserviceaccount.com'.

System.String

The full system path to the service account key in json or P12 format. You were given this file when you created the service account.

System.String

The password for the key. If not provided defaults to 'notasecret' which is usually the case.

OUTPUTS

NOTES

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

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]