Block-PUser

NAME Block-PUser



SYNOPSIS

Used to block a particular user account.





SYNTAX

Block-PUser [-PopuliUri] <String> [-PopuliAuthkey] <String> [-PersonId] <Int32> [[-Reason] <String>]

[<CommonParameters>]





DESCRIPTION

Users with the Academic Admin role can block anyone. Users with the Staff role can block anyone except for users

with the Academic Admin role.

The user status of current Account Admins and Billing Contacts can't be edited. You cannot block your user

account.





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



-PersonId <Int32>

Numeric ID of the person whose user account will be removed.

This parameter is required.



Required? true

Position? 3

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Reason <String>

The reason the user account is being blocked.



Required? false

Position? 4

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:

Result = SUCCESS (or FAILURE)





NOTES





Author: Matthew Rehm

Creation Date: 02/15/2019



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



Block-PUser -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890' -PersonId

7857760 -Reason "No longer attending."













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>#Store your Populi Credentials in a hash table:



$PopuliCredentials = @{

PopuliURI = https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Block-PUser @PopuliCredentials -PersonId 7857760











RELATED LINKS