Set-SPServiceApplicationSecurity

Reference

Module:: SharePointServer

Applies to:: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Updates the SPObjectSecurity object for a service application.

Syntax

Set-SPServiceApplicationSecurity
   [-Identity] <SPServiceApplicationPipeBind>
   [-ObjectSecurity] <SPObjectSecurity>
   [-Admin]
   [-AssignmentCollection <SPAssignmentCollection>]
   [<CommonParameters>]

Description

The Set-SPServiceApplicationSecurity cmdlet updates a security object for the specified service application. Use this cmdlet with the Grant-SPObjectSecurity and Get-SPServiceApplicationSecurity cmdlets to manage security for a service application.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

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

$sa = Get-SPServiceApplication -Identity <ID>
$security = Get-SPServiceApplicationSecurity $sa -Admin
$principal = New-SPClaimsPrincipal contoso\johndoe -IdentityType WindowsSamAccountName
Grant-SPObjectSecurity $security $principal "Full Control"
Set-SPServiceApplicationSecurity $sa -Admin $security

This example retrieves the SPObjectSecurity object corresponding to the administrator ACL on a service application and adds a new user principal to that ACL. The new user is an administrator for the service application $serviceApp.

Parameters

-Admin

Updates the access control list (ACL) that contains the administrators list of the service application.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-AssignmentCollection

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.

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.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-Identity

Specifies the service application that contains the SPObjectSecurity object to update.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application (for example, ServiceApp1); or an instance of a valid SPServiceApplication object.

Type:	SPServiceApplicationPipeBind
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

-ObjectSecurity

Specifies the SPObjectSecurity object to update.

Type:	SPObjectSecurity
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Share via