Get-SecurityPrincipal

 

Applies to: Exchange Online, Exchange Online Protection, Exchange Server 2016, Office 365 Security & Compliance Center

Topic Last Modified: 2016-04-06

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-SecurityPrincipal cmdlet to return a list of security principals. Security principals are entities, such as users or security groups, which can be assigned permissions and user rights.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-SecurityPrincipal [-Identity <ExtendedSecurityPrincipalIdParameter>] [-DomainController <Fqdn>] [-Filter <String>] [-IncludeDomainLocalFrom <SmtpDomain>] [-OrganizationalUnit <ExtendedOrganizationalUnitIdParameter>] [-ResultSize <Unlimited>] [-RoleGroupAssignable <SwitchParameter>] [-Types <MultiValuedProperty>]

This example retrieves security principals from the People OU.

Get-SecurityPrincipal -OrganizationalUnit OU=People,DC=Contoso,DC=com

This example retrieves security principals from the Legal department by using the Filter parameter. Only security principals matching the filter condition are retrieved.

Get-SecurityPrincipal -Filter {Department -eq "Legal"}

This example retrieves a single security principal explicitly specified by using the Identity parameter.

Get-SecurityPrincipal -Identity Administrator

This example retrieves well-known security principals and displays only the Name and SID properties in the results.

Get-SecurityPrincipal -Types WellKnownSecurityPrincipal | Format-Table Name,SID -AutoSize

The Get-SecurityPrincipal cmdlet is used by the Exchange admin center to populate fields that display recipient information.

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 "Active Directory Domain Services server settings" entry in the Exchange infrastructure and PowerShell permissions topic.

 

Parameter Required Type Description

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Filter

Optional

System.String

The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {<Property> -<Comparison operator> '<Value>'}.

  • <Property> is a filterable property.

  • -<Comparison Operator> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about_Comparison_Operators.

  • <Value> is the property value. Values that aren't integers need to be enclosed in quotation marks ('Value').

You can chain multiple search criteria together using the logical operators -and and -or. For example, {<Criteria1>) -and <Criteria2>} or {(<Criteria1> -and <Criteria2>) -or <Criteria3>}.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.ExtendedSecurityPrincipalIdParameter

The Identity parameter specifies the security principal. When the security principal is explicitly specified by using this parameter, no additional security principals are returned.

IncludeDomainLocalFrom

Optional

Microsoft.Exchange.Data.SmtpDomain

This parameter is available only in on-premises Exchange 2016.

The IncludeDomainLocalFrom parameter specifies whether to return domain local groups from the FQDN of the specified Active Directory domain (for example, contoso.com) in the results.

Don't use this parameter with the Filter or Identity parameters.

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.ExtendedOrganizationalUnitIdParameter

The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:

  • Name

  • Canonical name

  • Distinguished name (DN)

  • GUID

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

RoleGroupAssignable

Optional

System.Management.Automation.SwitchParameter

The RoleGroupAssignable switch filters security principals by returning only objects that can be assigned to an RBAC role group. You don't need to specify a value with this switch.

Types

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The Types parameter filters the results by object type. Valid values are:

  • Computer

  • GlobalSecurityGroup

  • Group

  • UniversalSecurityGroup

  • User

  • WellknownSecurityPrincipal

You can specify multiple values separated by commas.

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.

 
Show: