New-GSCourseInvitation¶
SYNOPSIS¶
Creates a course invitation.
SYNTAX¶
New-GSCourseInvitation [-CourseId] <String> [[-UserId] <String[]>] [[-Role] <String>] [[-User] <String>] [<CommonParameters>]
DESCRIPTION¶
Creates a course invitation.
EXAMPLES¶
EXAMPLE 1¶
New-GSCourseInvitation -CourseId philosophy-101 -UserId [email protected] -Role TEACHER
PARAMETERS¶
-CourseId¶
Identifier of the course to invite the user to. This identifier can be either the Classroom-assigned identifier or an alias.
Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False
-Role¶
Role to invite the user to have from the following:
- STUDENT
- TEACHER
- OWNER
Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: STUDENT Accept pipeline input: False Accept wildcard characters: False
-User¶
The user to authenticate the request as
Type: String Parameter Sets: (All) Aliases: Required: False Position: 4 Default value: $Script:PSGSuite.AdminEmail Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False
-UserId¶
Identifier of the user to invite. The identifier can be 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: PrimaryEmail, Email, Mail Required: False Position: 2 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.