End User
This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Creates a new end user.
SYNTAX
New-NinjaOneEndUser [-endUser] <Object> [-sendInvitation] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
Creates a new end user via the NinjaOne v2 API.
EXAMPLES
EXAMPLE 1
New-NinjaOneEndUser -endUser @{ firstName = 'Jane'; lastName = 'Doe'; email = '[email protected]' }
Creates a new end user.
EXAMPLE 2
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - BEGIN
PS> $body = @{
firstName = "string"
lastName = "string"
email = "string"
phone = "string"
organizationId = 0
fullPortalAccess = $false
}
PS> New-NinjaOneEndUser -endUser $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END
Full request example (auto-generated).
PARAMETERS
-endUser
End user payload per API schema.
Type: Object
Parameter Sets: (All)
Aliases: body
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-sendInvitation
Send invitation to end user during creation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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
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
A PowerShell object containing the created end user.
NOTES
RELATED LINKS
https://docs.homotechsual.dev/modules/ninjaone/commandlets/New/enduser