Remove-PRole

NAME Remove-PRole



SYNOPSIS

Removes a role from a person.





SYNTAX

Remove-PRole [-PopuliUri] <String> [-PopuliAuthkey] <String> -PersonId <Int32> -RoleId <Int32> [-WhatIf]

[-Confirm] [<CommonParameters>]





DESCRIPTION

Unfortunately, at this time the Student role cannot be added/removed through the API. The current user must have

the Staff role and permission to

remove the role (this varies by role... so Academic Admins can remove the Registrar role, Admissions Admins can

remove the Admission role, etc).

See Get-PAvailableRoles to look up all possible roles and their numeric IDs.





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 you're interested in.

This parameter is required.



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-RoleId <Int32>

The numeric ID of the role you want to remove.

This parameter is required.



Required? true

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

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

SUCCESS or FAILURE





NOTES





Author: Matthew Rehm

Creation Date: 02/15/2019

Updated: 04/30/2019



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



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

7857760 -RoleId 3













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



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



$PopuliCredentials = @{

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

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Remove-PRole @PopuliCredentials -PersonId 7857760 -RoleId 3











RELATED LINKS