[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Enables an administrator to unlock the PIN authentication number for the specified user. PIN authentication provides a way for users to access Microsoft Communications Server 2010 using a telephone that does not have an alphanumeric keyboard and thus cannot be used to enter the user name and password. If a user's PIN has been locked then he or she cannot use that number to access the system until the PIN has been unlocked.


Unlock-CsClientPin -Identity <UserIdParameter> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description




Indicates the Identity of the user account whose PIN number should be unlocked. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's Universal Principal Name; 3) the user's domain name and logon name, in the form domain\logon (e.g., litwareinc\kenmyer); and, 4_ the user's Active Directory display name (for example, Ken Myer). Note that the SamAccountName cannot be used as an identity; that's because SamAccountNames are not necessarily unique in a forest.

In addition, you can use the asterisk (*) wildcard character when using the Display Name as the user Identity. For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith".



Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.



Switch Parameter

Describes what would happen if you executed the command without actually executing the command.



Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

Communications Server 2010 enables users to connect to the system, or to join PSTN (Public Switched Telephone Network) conferences via telephone. Typically, logging on to the system or joining a conference requires the user to enter a user name or password; unfortunately, entering a user name and password can be a problem if you are using a phone that does not have an alphanumeric keypad. Because of that, Communications Server enables you to supply users with numeric-only PIN numbers; when prompted, users can then log on to the system or join a conference by entering the PIN number instead of a user name and password.

This is true, however, only if the user's PIN is unlocked; if a PIN number has been locked (either because the user repeatedly failed to logon or because an administrator explicitly locked the PIN) the user will not be able to access the system or join conferences using PIN authentication. (However, that user will still be able to use an application like Communicator to logon to the system by supplying a user name and password.) If a PIN has been locked there is only one way to restore the user's ability to access the system using PIN authentication: that PIN number must be unlocked by an administrator. One way to unlock PIN numbers is to use the cmdlet Unlock-CsClientPin.

Return Types

Unlock-CsClientPin does not return a value or object. Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Management.UserPinService.PinInfoDetails object.


-------------------------- Example 1 ------------------------

Copy Code
Unlock-CsClientPin -Identity "litwareinc\kenmyer"

In Example 1, Unlock-CsClientPin is used to unlock the PIN number belong to the user litwareinc\kenmyer.

-------------------------- Example 2 ------------------------

Copy Code
Get-CsUser | Get-CsClientPinInfo | Where-Object {$_.IsLockedOut -eq $True} | Unlock-CsClientPin 

In the preceding example, Unlock-CsClientPin is used to unlock all the PIN numbers that are currently locked. To do this, Get-CsUser is first used to return a collection of all the users who have been enabled for Communications Server. That collection is then piped to Get-CsClientPinInfo; Get-CsClientPinInfo is used in conjunction with the Where-Object cmdlet to return only those users where the IsLockedOut property is equal to (-eq) to True ($True). When that command completes, the collection will contain only users who have locked PIN numbers. That collection is then piped to UnlockCsClientPin, which unlocks the PIN number for each user whose PIN was previously locked.