Skip to content

Get GARoleAssignment

Spencer Varney edited this page Dec 27, 2016 · 3 revisions

Get-GARoleAssignment

SYNOPSIS

Retrieve a role assignment.

SYNTAX

One (Default)

Get-GARoleAssignment [[-Customer] <String>] [-RoleAssignmentId] <String>
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

List

Get-GARoleAssignment [[-Customer] <String>] [-All] [[-MaxResults] <Int32>] [[-RoleId] <String>]
 [[-UserKey] <String>] [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf]
 [-Confirm]

DESCRIPTION

Retrieve a role assignment.

EXAMPLES

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

PS C:\> Get-GARoleAssignment -Customer $SomeCustomerString -RoleAssignmentId $SomeRoleAssignmentIdString

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.

---------- EXAMPLE 2 ----------

PS C:\> Get-GARoleAssignment -Customer $SomeCustomerString -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.

PARAMETERS

-Customer

Immutable ID of the Google Apps account.

Type: String
Parameter Sets: (All)
Aliases: 

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

-RoleAssignmentId

Immutable ID of the role assignment.

Type: String
Parameter Sets: One
Aliases: 

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

-All

A switch to list all results

Type: SwitchParameter
Parameter Sets: List
Aliases: 

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

-MaxResults

Maximum number of results to return.

Type: Int32
Parameter Sets: List
Aliases: 

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

-RoleId

Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.

Type: String
Parameter Sets: List
Aliases: 

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

-UserKey

The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.

Type: String
Parameter Sets: List
Aliases: 

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

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

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

-GAuthId

The 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: False

INPUTS

System.String

Immutable ID of the Google Apps account.

System.String

Immutable ID of the role assignment.

System.Int32

Maximum number of results to return.

System.String

Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.

System.String

The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.

OUTPUTS

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]

Clone this wiki locally