Set-SPProfileServiceApplicationSecurity

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Sets permission and identity information.

Syntax

Set-SPProfileServiceApplicationSecurity
   -Identity <SPObjectSecurity>
   -ProfileServiceApplicationProxy <SPServiceApplicationProxyPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-SiteSubscription <SPSiteSubscriptionPipeBind>]
   [-Type <String>]
   [-WhatIf]
   [<CommonParameters>]

Description

Use the Set-SPProfileServiceApplictionSecurity cmdlet to set permission and identity information for the following User Profile objects:

Read individual My Sites
Use Personal Features
Use Social Features
Create Personal Site

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

Examples

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

$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'}
$security = Get-SPProfileServiceApplicationSecurity -ProfileServiceApplicationProxy $proxy
$everyone = New-SPClaimsPrincipal -Identity 'c:0(.s|true' -IdentityType EncodedClaim
Revoke-SPObjectSecurity -Identity $security -Principal $everyone -Rights 'Create Personal Site'
Set-SPProfileServiceApplicationSecurity -Identity $security -ProfileServiceApplicationProxy $proxy

This example revokes the right 'Create Personal Site' from All Authenticated Users.

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

$proxy = Get-SPServiceApplicationProxy | ?{$_.TypeName -eq 'User Profile Service Application Proxy'}
$security = Get-SPProfileServiceApplicationSecurity -ProfileServiceApplicationProxy $proxy
$everyone = New-SPClaimsPrincipal -Identity 'c:0(.s|true' -IdentityType EncodedClaim
Grant-SPObjectSecurity -Identity $security -Principal $everyone -Rights 'All'
Set-SPProfileServiceApplicationSecurity -Identity $security -ProfileServiceApplicationProxy $proxy

This example grants the right 'All' to All Authenticated Users.

Parameters

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

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Identity

Specifies the User Profile Service Application security object.

Type:	SPObjectSecurity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-ProfileServiceApplicationProxy

Specifies the unique identifier for the proxy.

Type:	SPServiceApplicationProxyPipeBind
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-SiteSubscription

Specifies the account under which this service should run. This parameter is mandatory in a hosted-environment and optional in a non-hosted environment.

Type:	SPSiteSubscriptionPipeBind
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Type

Specifies the type of object to display.

The type is any one of the following values:

MySiteReaderACL
UserACL

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

Share via