Get-VPASDirectoryDetails


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET DIRCECTORY DETAILS


Description:

USE THIS FUNCTION TO GET DIRECTORY DETAILS


Syntax:

Get-VPASDirectoryDetails [-DirectoryID] <String> [[-token] <Hashtable>] [<CommonParameters>]


Parameters:

-DirectoryID <String>
Unique DirectoryID that maps to the target Directory to retrieve details

Required: true
Position: 1
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: 2
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:

$DirectoryDetailsJSON = Get-VPASDirectoryDetails -DirectoryID {DIRECTORYID VALUE}


Outputs:

If successful:
{
         "DirectoryType": "MicrosoftADProfile.ini",
         "BindUsername": "bindacct@vman.com",
         "BindPassword": "",
         "SSLConnect": false,
         "LDAPDirectoryName": "vman.com",
         "LDAPDirectoryQueryOrder": 1,
         "LDAPDirectoryDescription": "",
         "VaultObjectNamesPrefix": "",
         "PasswordObjectPath": "root\\vman.com.pass",
         "LDAPDirectoryGroupBaseContext": "DC=vman,DC=com",
         "ReferralsChasingHopLimit": -1,
         "AppendFriendlyDomainNameToGroup": false,
         "RequireReferredDirectoryDefinition": false,
         "ReferralsDNSLookup": false,
         "DisableUserEnumeration": false,
         "AdditionalQueryFilterOptimize": true,
         "ClientBrowsing": true,
         "ExternalObjectCreation": true,
         "Authentication": true,
         "UseLDAPCertificatesOnly": false,
         "DisablePaging": false,
         "ProvisionDisabledUsers": false,
         "LDAPDirectoryUsage": [
                 "ExternalObjectCreation",
                 "ClientBrowsing",
                 "Authentication"
         ],
         "DCList": [
                 {
                         "Name": "192.168.111.111",
                         "Port": 389,
                         "SSLConnect": false
                 }
         ],
         "DomainName": "vman.com",
         "DomainBaseContext": "DC=vman,DC=com"
}

$false if failed