Set-SPPeoplePickerConfig
This cmdlet sets settings of People Picker of a specified Web application.
Syntax
Set-SPPeoplePickerConfig
-WebApplication <SPWebApplicationPipeBind>
[-ActiveDirectoryCustomFilter <String>]
[-ActiveDirectoryCustomQuery <String>]
[-ActiveDirectorySearchTimeout <Int32>]
[-PeopleEditorOnlyResolveWithinSiteCollection]
[-OnlySearchWithinSiteCollection]
[-NoWindowsAccountsForNonWindowsAuthenticationMode]
[-AssignmentCollection <SPAssignmentCollection>]
[-WhatIf]
[-SecureSocketsLayer]
[-Confirm]
[<CommonParameters>] Description
This Set-SPPeoplePickerConfig cmdlet sets the following settings of People Picker of a specified Web application: 1) The customized query filter sent to AD with People Picker query. 2) The customized query sent to AD with People Picker query. 3) The amount of time before AD search time out. 4) Whether the People Picker control should only return the site collection users when clicking the "Check Names" button. 5) Whether the People Picker control should only return the site collection users when using the "Select People and Groups" dialog box. 6) Whether return only non-Active Directory users when the Web application uses form-based authentication. 7) Whether to enable Secure LDAP (LDAPS) for secure communication.
Examples
-------------EXAMPLE 1-------------
Set-SPPeoplePickerConfig -WebApplication http://MyOfficeApp1 -ActiveDirectoryCustomFilter "((Title=Manager))" -ActiveDirectoryCustomQuery (sn={0}*) -ActiveDirectorySearchTimeout 60 -PeopleEditorOnlyResolveWithinSiteCollection -OnlySearchWithinSiteCollection -NoWindowsAccountsForNonWindowsAuthenticationModeThis example sets the following settings to the People Picker of Web application MyOfficeApp1: - Return a list of Active Directory users with a title of "Manager" - The query only searches on the last name - 60 seconds before Active Directory search times out - The People Picker control should only return the site collection users when clicking the "Check Names" button - The People Picker control should only return the site collection users when useing the "Select People and Groups" dialog box - The People Picker control return only non-Active Directory users when the Web application uses forms-based authentication
Parameters
-ActiveDirectoryCustomFilter
The Lightweight Directory Access Protocol (LDAP) query string to create a customized filter for displaying query results.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-ActiveDirectoryCustomQuery
The Lightweight Directory Access Protocol (LDAP) query string appended to the People Picker query to Active Directory.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-ActiveDirectorySearchTimeout
The amount of seconds of time before Active Directory search times out.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-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 running the cmdlet.
| 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 |
-NoWindowsAccountsForNonWindowsAuthenticationMode
Specifies the People Picker control return only non-Active Directory users when the Web application uses form-based authentication.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-OnlySearchWithinSiteCollection
Specifies the People Picker control should only return the site collection users when using the "Select People and Groups" dialog box.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-PeopleEditorOnlyResolveWithinSiteCollection
Specifies the People Picker control should only return the site collection users when click the "Check Names" button.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-SecureSocketsLayer
Specifies whether to enable Secure LDAP (LDAPS) for secure communication in the SharePoint People Picker.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-WebApplication
The Web application to set People Picker settings to.
| Type: | SPWebApplicationPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server Subscription Edition |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| 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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for