TestimoX

API Reference

Command

Convert-ADXIdentity

Namespace ADPlayground.PowerShell
Inputs
System.Security.Principal.SecurityIdentifier System.String System.String[]
Outputs
ADPlayground.Identity.CacheMetrics ADPlayground.Identity.IdentityInfo

Converts identity representations (SID, UPN, SAM, DN) to a unified IdentityInfo.

Remarks

Returns rich, typed identity data. By default, attempts a fast directory lookup (GC-first) with a short time budget, then falls back to cached translation. Use -TimeoutMs to adjust the directory lookup budget.

Examples

Authored help example

Example 1: Resolve from SID

PS>


Convert-ADXIdentity -Sid 'S-1-5-32-544'

Returns IdentityInfo for BUILTIN\Administrators.

Example 2: Resolve from name (auto UPN/SAM detection)

PS>


Convert-ADXIdentity -Identity 'jdoe@contoso.com'

Returns enriched IdentityInfo including DN, Kind, and Enabled where applicable.

Example 3: Batch with custom time budget

PS>


'S-1-5-21-...-512','CONTOSO\\Domain Admins' | Convert-ADXIdentity -TimeoutMs 800

Per lookup, allows up to 800 ms of directory time before falling back.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Convert-ADXIdentity -Identity <string[]> [-Force] [-MaxConcurrency <int>] [-ShowMetrics] [-TimeoutMs <int>] [<CommonParameters>]
#
Parameter set: By Identity

Parameters

Identity string[] requiredposition: 0pipeline: true (ByValue, ByPropertyName)
Identities in SID, UPN, SAM or DN format.
Force SwitchParameter optionalposition: namedpipeline: false
Continues even when resolution fails.
MaxConcurrency int optionalposition: namedpipeline: false
Maximum parallelism for batch conversions. 0 = sequential.
ShowMetrics SwitchParameter optionalposition: namedpipeline: false
Displays resolver cache metrics after processing.
TimeoutMs int optionalposition: namedpipeline: false
Optional server time limit (milliseconds) for directory lookups; when exceeded, falls back to cached resolution.

Outputs

ADPlayground.Identity.CacheMetrics, ADPlayground.Identity.IdentityInfo

Convert-ADXIdentity -Sid <SecurityIdentifier> [-Force] [-MaxConcurrency <int>] [-ShowMetrics] [-TimeoutMs <int>] [<CommonParameters>]
#
Parameter set: By Sid

Parameters

Sid SecurityIdentifier requiredposition: 0pipeline: true (ByValue, ByPropertyName)
Security identifier to resolve.
Force SwitchParameter optionalposition: namedpipeline: false
Continues even when resolution fails.
MaxConcurrency int optionalposition: namedpipeline: false
Maximum parallelism for batch conversions. 0 = sequential.
ShowMetrics SwitchParameter optionalposition: namedpipeline: false
Displays resolver cache metrics after processing.
TimeoutMs int optionalposition: namedpipeline: false
Optional server time limit (milliseconds) for directory lookups; when exceeded, falls back to cached resolution.

Outputs

ADPlayground.Identity.CacheMetrics, ADPlayground.Identity.IdentityInfo

Convert-ADXIdentity -Name <string> [-Force] [-MaxConcurrency <int>] [-ShowMetrics] [-TimeoutMs <int>] [<CommonParameters>]
#
Parameter set: By Name

Parameters

Name string requiredposition: 0pipeline: true (ByValue, ByPropertyName)
Account name to resolve.
Force SwitchParameter optionalposition: namedpipeline: false
Continues even when resolution fails.
MaxConcurrency int optionalposition: namedpipeline: false
Maximum parallelism for batch conversions. 0 = sequential.
ShowMetrics SwitchParameter optionalposition: namedpipeline: false
Displays resolver cache metrics after processing.
TimeoutMs int optionalposition: namedpipeline: false
Optional server time limit (milliseconds) for directory lookups; when exceeded, falls back to cached resolution.

Outputs

ADPlayground.Identity.CacheMetrics, ADPlayground.Identity.IdentityInfo