Get-PASDirectoryMapping

Get-PASDirectoryMapping

SYNOPSIS

Get directory mappings configured for a directory

SYNTAX

All (Default)

Get-PASDirectoryMapping -DirectoryName <String> [<CommonParameters>]

Mapping

Get-PASDirectoryMapping -DirectoryName <String> -MappingID <String> [<CommonParameters>]

DESCRIPTION

Returns a list of existing directory mappings in the Vault.

Membership of the Vault Admins group required.

EXAMPLES

EXAMPLE 1

Get-PASDirectory | Get-PASDirectoryMapping

Returns LDAP directory mappings configured for each directory.

EXAMPLE 2

Get-PASDirectoryMapping -DirectoryName SomeDir -MappingID "User_Mapping"

Returns information on the User_Mapping for SomeDir

EXAMPLE 3

[pscustomobject]@{DomainName = "SomeDir"} | Get-PASDirectoryMapping

Returns LDAP directory mappings configured for SomeDir, providing the directory name via the DomainName alias by property name.

EXAMPLE 4

[pscustomobject]@{DirectoryName = "SomeDir"; MappingID = "User_Mapping"} | Get-PASDirectoryMapping

Returns information on the User_Mapping mapping for SomeDir, using pipeline input for both the directory name and mapping ID.

PARAMETERS

-DirectoryName

The ID or Name of the directory to return data on.

Type: String
Parameter Sets: (All)
Aliases: DomainName

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-MappingID

The ID or Name of the directory mapping to return information on.

Type: String
Parameter Sets: Mapping
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.

INPUTS

OUTPUTS

NOTES

https://pspas.pspete.dev/commands/Get-PASDirectoryMapping

https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/WebServices/GetDirectoryMappingList.htm

https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/WebServices/GetMappingDetails.htm