-
Notifications
You must be signed in to change notification settings - Fork 10
Get GAUser
retrieve user
Get-GAUser [-UserKey] <String> [[-CustomFieldMask] <String>] [[-Projection] <ProjectionEnum>]
[[-View] <ViewTypeEnum>] [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf]
[-Confirm]
Get-GAUser [-All] [[-CustomFieldMask] <String>] [[-ProjectionType] <ProjectionEnum>]
[[-ViewType] <ViewTypeEnum>] [[-Customer] <String>] [[-Domain] <String>] [[-MaxResults] <Int32>]
[[-OrderBy] <OrderByEnum>] [[-Query] <String>] [[-ShowDeleted] <String>] [[-SortOrder] <SortOrderEnum>]
[-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]
retrieve user
PS C:\> Get-GAUser -UserKey $SomeUserKeyString
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.
PS C:\> Get-GAUser -All
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.
Email or immutable Id of the user
Type: String
Parameter Sets: OneUser
Aliases:
Required: True
Position: 0
Default value:
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseA switch to list all results.
Type: SwitchParameter
Parameter Sets: AllUsers
Aliases:
Required: False
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseComma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhat subset of fields to fetch for this user.
Possible values: Basic, Custom, Full
Type: ProjectionEnum
Parameter Sets: OneUser
Aliases:
Accepted values: Basic, Custom, Full
Required: False
Position: 3
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalsePossible values: Basic, Custom, Full
Type: ProjectionEnum
Parameter Sets: AllUsers
Aliases:
Accepted values: Basic, Custom, Full
Required: False
Position: 3
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
Possible values: AdminView, DomainPublic
Type: ViewTypeEnum
Parameter Sets: OneUser
Aliases:
Accepted values: AdminView, DomainPublic
Required: False
Position: 4
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalsePossible values: AdminView, DomainPublic
Type: ViewTypeEnum
Parameter Sets: AllUsers
Aliases:
Accepted values: AdminView, DomainPublic
Required: False
Position: 4
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseImmutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
Type: String
Parameter Sets: AllUsers
Aliases:
Required: False
Position: 5
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseName of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.
Type: String
Parameter Sets: AllUsers
Aliases:
Required: False
Position: 6
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseMaximum number of results to return. Default is 100. Max allowed is 500
Type: Int32
Parameter Sets: AllUsers
Aliases:
Required: False
Position: 8
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseColumn to use for sorting results
Possible values: Email, FamilyName, GivenName
Type: OrderByEnum
Parameter Sets: AllUsers
Aliases:
Accepted values: Email, FamilyName, GivenName
Required: False
Position: 9
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseQuery string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
Type: String
Parameter Sets: AllUsers
Aliases:
Required: False
Position: 10
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseIf set to true retrieves the list of deleted users. Default is false
Type: String
Parameter Sets: AllUsers
Aliases:
Required: False
Position: 11
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseWhether to return results in ascending or descending order.
Possible values: ASCENDING, DESCENDING
Type: SortOrderEnum
Parameter Sets: AllUsers
Aliases:
Accepted values: ASCENDING, DESCENDING
Required: False
Position: 12
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA Standard Query Parameters Object.
Type: StandardQueryParameters
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe 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: FalseEmail or immutable Id of the user
Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.
What subset of fields to fetch for this user.
Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.
Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.
Maximum number of results to return. Default is 100. Max allowed is 500
Column to use for sorting results
Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users
If set to true retrieves the list of deleted users. Default is false
Whether to return results in ascending or descending order.
Part of the gShell Project, relating to the Google Directory API; see Related Links or use the -Online parameter.
News - Get Started - Cmdlet Index - FAQ - Discussion - Downloads