-
Notifications
You must be signed in to change notification settings - Fork 10
Get GClassroomGuardian
Returns a specific guardian, or a list of guardians that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors.
- `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`).
- `NOT_FOUND` if Classroom cannot find any record of the given student or `guardian_id`, or if the guardian has been disabled.
Get-GClassroomGuardian [-StudentId] <String> [-GuardianId] <String>
[-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]
Get-GClassroomGuardian [-StudentId] <String> [[-InvitedEmailAddress] <String>] [[-PageSize] <Int32>]
[-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]
Returns a specific guardian, or a list of guardians that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors.
- `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`).
- `NOT_FOUND` if Classroom cannot find any record of the given student or `guardian_id`, or if the guardian has been disabled.
PS C:\> Get-GClassroomGuardian -StudentId $SomeStudentIdString -GuardianId $SomeGuardianIdString
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-GClassroomGuardian -StudentId $SomeStudentIdString -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.
The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe `id` field from a `Guardian`.
Type: String
Parameter Sets: one
Aliases:
Required: True
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseFilter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.
Type: String
Parameter Sets: list
Aliases:
Required: False
Position: 1
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseMaximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
Type: Int32
Parameter Sets: list
Aliases:
Required: False
Position: 2
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: FalseThe student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
The `id` field from a `Guardian`.
Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.
Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
Part of the gShell Project, relating to the Google Classroom API; see Related Links or use the -Online parameter.
News - Get Started - Cmdlet Index - FAQ - Discussion - Downloads