Skip to content

SPUserProfileServiceAppPermissions

dscbot edited this page Mar 17, 2023 · 19 revisions

SPUserProfileServiceAppPermissions

Parameters

Parameter Attribute DataType Description Allowed Values
ProxyName Key String The name of the proxy that is attached to the user profile service you wish to set permissions for
CreatePersonalSite Write StringArray[] A list of user principals that will have the Create personal site permission
FollowAndEditProfile Write StringArray[] A list of user principals that will have the Follow users and edit profile permission
UseTagsAndNotes Write StringArray[] A list of user principals that will have the Use tags and notes permission

Description

Type: Distributed Requires CredSSP: No

This resource will apply permissions to a user profile service application. These can control access to create my sites, use social features, and use tagging. If you want to allow all users the ability to use a specific permisisons include "Everyone" as a user in the corresponding property. To specify that there should be no permissions on a type, use "none"

Examples

Example 1

This example applies permissions for the user profile service application to limit access to specific features.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPUserProfileServiceAppPermissions UPAPermissions
        {
            ProxyName            = "User Profile Service Application Proxy"
            CreatePersonalSite   = @("DEMO\Group", "DEMO\User1")
            FollowAndEditProfile = @("Everyone")
            UseTagsAndNotes      = @("None")
            PsDscRunAsCredential = $SetupAccount
        }
    }
}
Clone this wiki locally