Get-XdrIdentityIdentity
SYNOPSIS
Retrieves identities from Microsoft Defender for Identity.
SYNTAX
Paged (Default)
Get-XdrIdentityIdentity [-SortByField <String>] [-SortDirection <String>] [-PageSize <Int32>] [-Skip <Int32>]
[-SearchText <String>] [-IdentityProvider <String[]>] [-IdentityEnvironment <String[]>] [-Force]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
All
Get-XdrIdentityIdentity [-SortByField <String>] [-SortDirection <String>] [-SearchText <String>]
[-IdentityProvider <String[]>] [-IdentityEnvironment <String[]>] [-All] [-Force]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Gets identities from Microsoft Defender for Identity with support for pagination, sorting, and search filtering. This function includes caching support with a 10-minute TTL to reduce API calls.
EXAMPLES
EXAMPLE 1
Get-XdrIdentityIdentity
Retrieves the first 20 identities sorted by RepresentableName in ascending order.
EXAMPLE 2
Get-XdrIdentityIdentity -SortByField CreatedDateTime -SortDirection Dsc
Retrieves identities sorted by creation date in descending order (newest first).
EXAMPLE 3
Get-XdrIdentityIdentity -PageSize 50 -Skip 100
Retrieves 50 identities, skipping the first 100 (for pagination).
EXAMPLE 4
Get-XdrIdentityIdentity -SearchText "admin"
Retrieves identities matching the search text "admin".
EXAMPLE 5
Get-XdrIdentityIdentity -SortByField AccountDomain -PageSize 100 -SearchText "contoso"
Retrieves up to 100 identities containing "contoso", sorted by account domain.
EXAMPLE 6
Get-XdrIdentityIdentity -IdentityProvider ActiveDirectory
Retrieves identities from Active Directory only.
EXAMPLE 7
Get-XdrIdentityIdentity -IdentityProvider ActiveDirectory, EntraID
Retrieves identities from both Active Directory and Entra ID.
EXAMPLE 8
Get-XdrIdentityIdentity -IdentityEnvironment ActiveDirectory
Retrieves identities with Active Directory as primary identity provider.
EXAMPLE 9
Get-XdrIdentityIdentity -IdentityEnvironment ActiveDirectory, EntraID
Retrieves identities with Active Directory or Entra ID as primary identity provider.
EXAMPLE 10
Get-XdrIdentityIdentity -SearchText "bob" -IdentityEnvironment ActiveDirectory
Retrieves identities matching "bob" from Active Directory only.
EXAMPLE 11
Get-XdrIdentityIdentity -Force
Forces a fresh retrieval of identities, bypassing the cache.
EXAMPLE 12
Get-XdrIdentityIdentity -All
Retrieves all identities by automatically paging through all results.
EXAMPLE 13
Get-XdrIdentityIdentity -All -SearchText "admin"
Retrieves all identities matching "admin" by paging through all results.
PARAMETERS
-SortByField
The field to sort results by. Valid values are "RepresentableName", "AccountDomain", and "CreatedDateTime". Default is "RepresentableName".
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: RepresentableName
Accept pipeline input: False
Accept wildcard characters: False
-SortDirection
The sort direction. Valid values are "Asc" (ascending) and "Dsc" (descending). Default is "Asc".
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: Asc
Accept pipeline input: False
Accept wildcard characters: False
-PageSize
The number of identities to retrieve per page. Default is 20. Maximum is 100.
Type: Int32
Parameter Sets: Paged
Aliases:
Required: False
Position: Named
Default value: 20
Accept pipeline input: False
Accept wildcard characters: False
-Skip
The number of identities to skip. Used for pagination. Default is 0.
Type: Int32
Parameter Sets: Paged
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-SearchText
Text to search for in identities. Only non-special characters are allowed.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IdentityProvider
Filters identities by identity provider. Valid values are "ActiveDirectory", "EntraID", and "Hybrid". Multiple values can be specified.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IdentityEnvironment
Filters identities by primary identity provider. Valid values are "ActiveDirectory", "EntraID", and "Hybrid". Multiple values can be specified.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-All
Retrieves all identities by automatically paging through all results. When specified, PageSize and Skip parameters are ignored.
Type: SwitchParameter
Parameter Sets: All
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Force
Bypasses the cache and forces a fresh retrieval from the API.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
The ProgressAction parameter is a common parameter, not a cmdlet parameter. For more information, see about_CommonParameters.
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.