Get-VPASDirectoryMappingDetails


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET DIRECTORY MAPPING DETAILS


Description:

USE THIS FUNCTION TO GET DIRECTORY MAPPING DETAILS


Syntax:

Get-VPASDirectoryMappingDetails [[-DomainName] <String>] [[-DirectoryMappingName] <String>] [[-DirectoryMappingID] <String>] [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-DomainName <String>
Target domain to query through

Required: false
Position: 1
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-DirectoryMappingName <String>
Search query to locate target DomainMapping

Required: false
Position: 2
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-DirectoryMappingID <String>
Unique ID that maps to the target Domain Mapping
Supply DirectoryMappingID to skip any querying to find target DirectoryMapping

Required: false
Position: 3
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: 4
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)


Examples:

$DirectoryMappingJSON = Get-VPASDirectoryMappingDetails -DirectoryMethodId {DIRECTORY MAPPING ID VALUE}


Outputs:

If successful:
{
         "LDAPBranch": "DC=vman,DC=com",
         "MappingAuthorizations": [
                 "AddUpdateUsers",
                 "AddSafes",
                 "AddNetworkAreas",
                 "ManageServerFileCategories",
                 "AuditUsers",
                 "ResetUsersPasswords",
                 "ActivateUsers"
         ],
         "Location": "\\",
         "AuthenticationMethod": [
                 "AuthTypeLDAP"
         ],
         "UserType": "EPVUser",
         "DisableUser": false,
         "UserActivityLogPeriod": 7,
         "UserExpiration": 0,
         "LogonFromHour": 0,
         "LogonToHour": 24,
         "UsedQuota": -1,
         "AuthorizedInterfaces": [
                
         ],
         "EnableENEWhenDisconnected": false,
         "MappingID": 36,
         "DirectoryMappingOrder": 1000,
         "MappingName": "Vault admins__vman.com",
         "LDAPQuery": "",
         "DomainGroups": [
                 "CAVaultAdmins"
         ]
}

$false if failed