< Back
Remove-PUser
Post
NAME Remove-PUser
SYNOPSIS
Removes the user account from a person.
SYNTAX
Remove-PUser [-PopuliUri] <String> [-PopuliAuthkey] <String> -PersonId <Int32> [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Users with the Academic Admin role can remove any user account. Users with the Staff role can remove any user
account except for users with
the Academic Admin role. The user status of current Account Admins and Billing Contacts can't be edited.
You cannot remove 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? named
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
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-PUser -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890' -PersonId
7857760
RELATED LINKS
SYNOPSIS
Removes the user account from a person.
SYNTAX
Remove-PUser [-PopuliUri] <String> [-PopuliAuthkey] <String> -PersonId <Int32> [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Users with the Academic Admin role can remove any user account. Users with the Staff role can remove any user
account except for users with
the Academic Admin role. The user status of current Account Admins and Billing Contacts can't be edited.
You cannot remove 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? named
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
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-PUser -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890' -PersonId
7857760
RELATED LINKS