Skip to content

New GClassroomInvitation

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

New-GClassroomInvitation

SYNOPSIS

Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors.

  • `NOT_FOUND` if the course or the user does not exist.
  • `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions.
  • `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

SYNTAX

New-GClassroomInvitation [[-InvitationBody] <Invitation>] [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors.

  • `NOT_FOUND` if the course or the user does not exist.
  • `FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions.
  • `ALREADY_EXISTS` if an invitation for the specified user and course already exists.

EXAMPLES

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

PS C:\> New-GClassroomInvitation -InvitationBody $SomeInvitationObj

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

-InvitationBody

An invitation to join a course.

Type: Invitation
Parameter Sets: (All)
Aliases: 

Required: False
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName, ByValue)
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

Google.Apis.Classroom.v1.Data.Invitation

An invitation to join a course.

OUTPUTS

NOTES

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

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]

Clone this wiki locally