Get-PUsers

NAME Get-PUsers



SYNOPSIS

Returns all users.





SYNTAX

Get-PUsers [-PopuliUri] <String> [-PopuliAuthkey] <String> [<CommonParameters>]





DESCRIPTION

You must have the Staff role to call this task.





PARAMETERS

-PopuliUri <String>

Set to the correct URL for your college (i.e. https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/).

This parameter is required.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PopuliAuthkey <String>

The authentication key with necessary permissions for the data you are requesting.

This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Returns PowerShell objects:

PersonId

FirstName

LastName

UserName

Blocked (1=Yes / 0=No)





NOTES





Author: Matthew Rehm

Creation Date: 02/15/2019



-------------------------- EXAMPLE 1 --------------------------



Get-PUsers -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890'















RELATED LINKS