Applies to: Exchange Server 2010 SP2, Exchange Server 2010 SP3

Topic Last Modified: 2015-03-09

Use the Get-UMMailboxPIN cmdlet to return information from a Unified Messaging (UM)-enabled user's mailbox.

Get-UMMailboxPin [-Identity <MailboxIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-IgnoreErrors <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>]

The Get-UMMailboxPIN cmdlet returns information that's calculated from the PIN data stored in encrypted form in the user's mailbox. This cmdlet also shows whether the mailbox or user access has been locked out.

After this task is completed, you can view information on a user's mailbox.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "UM mailbox" entry in the Unified Messaging Permissions topic.


Parameter Required Type Description




The Credential parameter specifies the user name and password to use to access Active Directory.

This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential.




The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.




The Identity parameter specifies the identifier that can be used to retrieve information about the mailbox. The values for this parameter include the following:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias




The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.

  • You can only use the distinguished name (DN) for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.

  • You can't use the Organization and Identity parameters together.

  • You can't use the Credential parameter.




The IgnoreErrors parameter specifies whether errors that may occur when running this cmdlet are written as warnings.




The Organization parameter is reserved for internal Microsoft use.




The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. If you have set the recipient scope to include all recipients in the forest and if you don't use this parameter, the user information may be read from a global catalog whose information is outdated. If you use this parameter, multiple reads may be necessary to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers.




The ResultSize parameter specifies a maximum number of results to be returned. If a maximum number isn't specified, the cmdlet returns all results.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

This example displays the UM mailbox PIN-related properties for all UM-enabled users.


This example displays the UM mailbox PIN-related properties for

Get-UMMailboxPIN -Identity