Skip to content

New GAUserObj

Jump to bottom Edit New page
Spencer Varney edited this page Dec 14, 2016 · 3 revisions

New-GAUserObj

SYNOPSIS

Creates a new Directory API User object.

SYNTAX

New-GAUserObj [[-Addresses] <Object>] [[-AgreedToTerms] <Boolean>] [[-Aliases] <String[]>]
 [[-ChangePasswordAtNextLogin] <Boolean>] [[-CreationTime] <DateTime>]
 [[-CustomSchemas] <System.Collections.Generic.IDictionary`2[System.String,System.Collections.Generic.IDictionary`2[System.String,System.Object]]>]
 [[-CustomerId] <String>] [[-DeletionTime] <DateTime>] [[-Emails] <Object>] [[-ExternalIds] <Object>]
 [[-HashFunction] <String>] [[-Id] <String>] [[-Ims] <Object>] [[-IncludeInGlobalAddressList] <Boolean>]
 [[-IpWhitelisted] <Boolean>] [[-IsAdmin] <Boolean>] [[-IsDelegatedAdmin] <Boolean>]
 [[-IsMailboxSetup] <Boolean>] [[-LastLoginTime] <DateTime>] [[-Name] <UserName>]
 [[-NonEditableAliases] <String[]>] [[-Notes] <Object>] [[-OrgUnitPath] <String>] [[-Organizations] <Object>]
 [[-Password] <String>] [[-Phones] <Object>] [[-PrimaryEmail] <String>] [[-Relations] <Object>]
 [[-Suspended] <Boolean>] [[-SuspensionReason] <String>] [[-ThumbnailPhotoEtag] <String>]
 [[-ThumbnailPhotoUrl] <String>] [[-Websites] <Object>] [-WhatIf] [-Confirm]

DESCRIPTION

This provides a Cmdlet-Based approach to creating a User object which may be required as a parameter for some other Cmdlets in the Directory API category.

You could alternately create this object by calling New-Object -TypeName Google.Apis.admin.Directory.directory_v1.Data.User

EXAMPLES

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

PS C:\> New-GAUserObj

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

-Addresses

An Addresses Object

Type: Object
Parameter Sets: (All)
Aliases: 

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

-AgreedToTerms

Indicates if user has agreed to terms (Read-only)

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-Aliases

List of aliases (Read-only)

Type: String[]
Parameter Sets: (All)
Aliases: 

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

-ChangePasswordAtNextLogin

Boolean indicating if the user should change password in next login

Type: Boolean
Parameter Sets: (All)
Aliases: 

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

-CreationTime

User's Google account creation time. (Read-only)

Type: DateTime
Parameter Sets: (All)
Aliases: 

Required: False
Position: 4
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CustomSchemas

Custom fields of the user.

Type: System.Collections.Generic.IDictionary`2[System.String,System.Collections.Generic.IDictionary`2[System.String,System.Object]]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 5
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CustomerId

CustomerId of User (Read-only)

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 6
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DeletionTime

A DeletionTime object

Type: DateTime
Parameter Sets: (All)
Aliases: 

Required: False
Position: 7
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Emails

An Emails object

Type: Object
Parameter Sets: (All)
Aliases: 

Required: False
Position: 8
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ExternalIds

An ExternalIds object

Type: Object
Parameter Sets: (All)
Aliases: 

Required: False
Position: 9
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-HashFunction

Hash function name for password. Supported are MD5, SHA-1 and crypt

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 10
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Id

Unique identifier of User (Read-only)

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 11
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Ims

An Ims object

Type: Object
Parameter Sets: (All)
Aliases: 

Required: False
Position: 12
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IncludeInGlobalAddressList

Boolean indicating if user is included in Global Address List

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 13
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IpWhitelisted

Boolean indicating if ip is whitelisted

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 14
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsAdmin

Boolean indicating if the user is admin (Read-only)

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 15
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsDelegatedAdmin

Boolean indicating if the user is delegated admin (Read-only)

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 16
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsMailboxSetup

Is mailbox setup (Read-only)

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 17
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-LastLoginTime

User's last login time. (Read-only)

Type: DateTime
Parameter Sets: (All)
Aliases: 

Required: False
Position: 18
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

User's name

Type: UserName
Parameter Sets: (All)
Aliases: 

Required: False
Position: 19
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-NonEditableAliases

List of non editable aliases (Read-only)

Type: String[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: 20
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Notes

A Notes object

Type: Object
Parameter Sets: (All)
Aliases: 

Required: False
Position: 21
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OrgUnitPath

OrgUnit of User

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 22
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Organizations

An Organizations object

Type: Object
Parameter Sets: (All)
Aliases: 

Required: False
Position: 23
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Password

User's password

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 24
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Phones

A Phones object

Type: Object
Parameter Sets: (All)
Aliases: 

Required: False
Position: 25
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PrimaryEmail

username of User

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 26
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Relations

A Relations object

Type: Object
Parameter Sets: (All)
Aliases: 

Required: False
Position: 27
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Suspended

Indicates if user is suspended

Type: Boolean
Parameter Sets: (All)
Aliases: 

Required: False
Position: 28
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SuspensionReason

Suspension reason if user is suspended (Read-only)

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 29
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ThumbnailPhotoEtag

ETag of the user's photo (Read-only)

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 30
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ThumbnailPhotoUrl

Photo Url of the user (Read-only)

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 31
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Websites

A Websites object

Type: Object
Parameter Sets: (All)
Aliases: 

Required: False
Position: 32
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

INPUTS

System.Object

System.Boolean

Indicates if user has agreed to terms (Read-only)

System.String[]

List of aliases (Read-only)

System.Boolean

Boolean indicating if the user should change password in next login

System.DateTime

User's Google account creation time. (Read-only)

System.Collections.Generic.IDictionary2[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Collections.Generic.IDictionary2System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Custom fields of the user.

System.String

CustomerId of User (Read-only)

System.DateTime

System.Object

System.Object

System.String

Hash function name for password. Supported are MD5, SHA-1 and crypt

System.String

Unique identifier of User (Read-only)

System.Object

System.Boolean

Boolean indicating if user is included in Global Address List

System.Boolean

Boolean indicating if ip is whitelisted

System.Boolean

Boolean indicating if the user is admin (Read-only)

System.Boolean

Boolean indicating if the user is delegated admin (Read-only)

System.Boolean

Is mailbox setup (Read-only)

System.DateTime

User's last login time. (Read-only)

Google.Apis.admin.Directory.directory_v1.Data.UserName

User's name

System.String[]

List of non editable aliases (Read-only)

System.Object

System.String

OrgUnit of User

System.Object

System.String

User's password

System.Object

System.String

username of User

System.Object

System.Boolean

Indicates if user is suspended

System.String

Suspension reason if user is suspended (Read-only)

System.String

ETag of the user's photo (Read-only)

System.String

Photo Url of the user (Read-only)

System.Object

OUTPUTS

Google.Apis.admin.Directory.directory_v1.Data.User

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]

News - Get Started - Cmdlet Index - FAQ - Discussion - Downloads

News
Get Started
Cmdlet Index
FAQ
Discussion
Downloads

Clone this wiki locally