Skip to main content

Get Users

Generated Cmdlet Help

This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Gets users from the NinjaOne API.

SYNTAX

Default (Default)

Get-NinjaOneUsers [[-userType] <String>] [-includeRoles] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

Organisation

Get-NinjaOneUsers [-organisationId] <Int32> [[-userType] <String>] [-includeRoles]
[-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves users from the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

Get-NinjaOneUsers

Gets all users.

EXAMPLE 2

Get-NinjaOneUsers -includeRoles

Gets all users including information about their roles.

EXAMPLE 3

Get-NinjaOneUsers -userType TECHNICIAN

Gets all technicians (users with the TECHNICIAN user type).

EXAMPLE 4

Get-NinjaOneUsers -organisationId 1

Gets all users for the organisation with id 1 (only works for users with the END_USER user type).

PARAMETERS

-organisationId

Get users for this organisation id.

Type: Int32
Parameter Sets: Organisation
Aliases: id, organizationId

Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-userType

Filter by user type. This can be one of "TECHNICIAN" or "END_USER".

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-includeRoles

Include roles in the response.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: False
Accept pipeline input: True (ByPropertyName)
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 response.

NOTES

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Get/users