Export (0) Print
Expand All
Expand Minimize
0 out of 1 rated this helpful - Rate this topic

Remove-SPAppPrincipalPermission

SharePoint 2013

Published: July 16, 2012

Applies to:  SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise 

Removes the permissions on a specified app principal.

Remove-SPAppPrincipalPermission -AppPrincipal <SPAppPrincipal> -Scope <Site | SiteCollection | SiteSubscription> -Site <SPWebPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DisableAppOnlyPolicy <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

AppPrincipal

Required

Microsoft.SharePoint.SPAppPrincipal

Specifies the AppPrincipal object to remove.

Scope

Required

Microsoft.SharePoint.PowerShell.SPCmdletAppPrincipalPermissionScope

Specifies the scope to which to apply the principal permission.

The value is any of the following scopes:

--Farm

--Site collection

--SharePoint Online

--Web

--Documents, List, or Library

Site

Required

Microsoft.SharePoint.PowerShell.SPWebPipeBind

Specifies the site (that is, SPWeb object) to remove.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

noteNote:

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Detailed Description

Use the Remove-SPAppPrincipalPermission cmdlet to remove the permissions on a specified app principal for a given scope (that is, SharePoint Online, site collection, or web).

Input Types

Return Types

---------------EXAMPLE------------

$appPrincipal= Get-SPApplicationPrincipal –nameIdentifier $spTrustedIssuer.nameIdentifier – web $site.rootWeb
Remove-AppPrincipalPermission –appPrincipal $appPrincipal –site $site.rootweb –scope "spweb"

This example removes the App Principal permission from the site collection scope.

Change History

Date Description

July 16, 2012

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.