Skip to main content

Get-HaloUser

Generated Cmdlet Help

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

SYNOPSIS

Gets users from the Halo API.

SYNTAX

Multi (Default)

Get-HaloUser [-Paginate] [-PageSize <Int32>] [-PageNo <Int32>] [-Order <String>] [-OrderDesc]
[-Search <String>] [-SearchPhoneNumbers] [-TopLevelID <Int32>] [-ClientID <Int32>] [-SiteID <Int32>]
[-OrganisationID <Int32>] [-DepartmentID <Int32>] [-AssetID <Int32>] [-IncludeActive] [-IncludeInactive]
[-ApproversOnly] [-ExcludeAgents] [-Count <Int32>] [-FullObjects] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

Single

Get-HaloUser -UserID <Int64> [-IncludeDetails] [-IncludeActivity] [-IncludePopups]
[-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves users from the Halo API - supports a variety of filtering parameters.

EXAMPLES

PARAMETERS

-UserID

User ID

Type: Int64
Parameter Sets: Single
Aliases:

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

-Paginate

Paginate results

Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate

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

-PageSize

Number of results per page.

Type: Int32
Parameter Sets: Multi
Aliases: page_size

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

-PageNo

Which page to return.

Type: Int32
Parameter Sets: Multi
Aliases: page_no

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

-Order

Which field to order results based on.

Type: String
Parameter Sets: Multi
Aliases:

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

-OrderDesc

Order results in descending order (respects the field choice in '-Order')

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

Return users matching the search term in the results.

Type: String
Parameter Sets: Multi
Aliases:

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

-SearchPhoneNumbers

Search on phone numbers when searching.

Type: SwitchParameter
Parameter Sets: Multi
Aliases: search_phonenumbers

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

-TopLevelID

Filter by the specified top level ID.

Type: Int32
Parameter Sets: Multi
Aliases: toplevel_id

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

-ClientID

Filter by the specified client ID.

Type: Int32
Parameter Sets: Multi
Aliases: client_id

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

-SiteID

Filter by the specified site ID.

Type: Int32
Parameter Sets: Multi
Aliases: site_id

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

-OrganisationID

Filter by the specified organisation ID.

Type: Int32
Parameter Sets: Multi
Aliases: organisation_id

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

-DepartmentID

Filter by the specified department ID.

Type: Int32
Parameter Sets: Multi
Aliases: department_id

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

-AssetID

Filter by the specified asset ID.

Type: Int32
Parameter Sets: Multi
Aliases: asset_id

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

-IncludeActive

Include active users in the results.

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-IncludeInactive

Include inactive users in the results.

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-ApproversOnly

Include approvers only in the results.

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-ExcludeAgents

Exclude users linked to agent accounts from the results.

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-Count

The number of users to return if not using pagination.

Type: Int32
Parameter Sets: Multi
Aliases:

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

-FullObjects

Parameter to return the full objects.

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-IncludeDetails

Include extra objects in the result.

Type: SwitchParameter
Parameter Sets: Single
Aliases:

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

-IncludeActivity

Include ticket activity in the result.

Type: SwitchParameter
Parameter Sets: Single
Aliases:

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

-IncludePopups

Include customer popups in the result.

Type: SwitchParameter
Parameter Sets: Single
Aliases:

Required: False
Position: Named
Default value: False
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 response.

NOTES