< Back

Unblock-PUser

Sat Jan 18, 2020 7:30 pm

NAME Unblock-PUser



SYNOPSIS

Used to unblock a particular user account.





SYNTAX

Unblock-PUser [-PopuliUri] <String> [-PopuliAuthkey] <String> [-PersonId] <Int32> [<CommonParameters>]





DESCRIPTION

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

users with the Academic Admin role.





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 unblocked.

This parameter is required.



Required? true

Position? 3

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

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 --------------------------



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

7857760













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



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



$PopuliCredentials = @{

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

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Unblock-PUser @PopuliCredentials -PersonId 7857760











RELATED LINKS