New-GitHubOrganizationInvitation¶

SYNOPSIS¶

Create an organization invitation

SYNTAX¶

UserID¶

New-GitHubOrganizationInvitation -Organization <String> -InviteeID <Int32> [-Role <String>]
 [-TeamIDs <Int32[]>] [-Context <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Email¶

New-GitHubOrganizationInvitation -Organization <String> -Email <String> [-Role <String>] [-TeamIDs <Int32[]>]
 [-Context <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION¶

Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

EXAMPLES¶

Example 1¶

PS C:> {{ Add example code here }}

PARAMETERS¶

-Organization¶

The organization name. The name is not case sensitive.

Type: String
Parameter Sets: (All)
Aliases: Org

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

-InviteeID¶

GitHub user ID for the person you are inviting.

Type: Int32
Parameter Sets: UserID
Aliases: invitee_id, user_id

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

-Email¶

Email address of the person you are inviting, which can be an existing GitHub user.

Type: String
Parameter Sets: Email
Aliases:

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

-Role¶

The role for the new member.

admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.
direct_member - Non-owner organization members with ability to see other members and join teams by invitation.
billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.
reinstate - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.

Type: String
Parameter Sets: (All)
Aliases:

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

-TeamIDs¶

Specify IDs for the teams you want to invite new members to.

Type: Int32[]
Parameter Sets: (All)
Aliases:

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

-Context¶

The context to run the command in

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: (Get-GitHubConfig -Name 'DefaultContext')
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf¶

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm¶

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-ProgressAction¶

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
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.

INPUTS¶

OUTPUTS¶

NOTES¶