Invoke-VPASCentralCredentialProvider


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

CENTRAL CREDENTIAL PROVIDER API CALL


Description:

USE THIS FUNCTION TO RETRIEVE ACCOUNT INFORMATION VIA CENTRAL CREDENTIAL PROVIDER


Syntax:

Invoke-VPASCentralCredentialProvider [-ApplicationID] <String> [-Safe] <String> [-ObjectName] <String> [[-Folder] <String>] [-CCPServer] <String> [[-AIMIISAppPool] <String>] [[-CertificateTP] <String>] [[-Certificate] <X509Certificate>] [[-Reason] <String>] [[-NoSSL]] [<CommonParameters>]


Parameters:

-ApplicationID <String>
The application ID that has access to the safe that will retrieve the account information

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

-Safe <String>
Safe that the target account is located in

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

-ObjectName <String>
Unique identifier of the target account

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

-Folder <String>
A directory within a safe that the target account is located in
Default value: root

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

-CCPServer <String>
Server fully qualified domain name (FQDN) or IP that the central credential provider(s) are deployed on

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

-AIMIISAppPool <String>
IIS endpoint that the AIMWebService is deployed to
Default value: AIMWebService

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

-CertificateTP <String>
Thumbprint of the certificate being used to make the call for applications configured with certificate authentication

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

-Certificate <X509Certificate>
Certificate being used to make the call for applications configured with certificate authentication

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

-Reason <String>
Purpose for pulling the account, for auditing and master policy restriction

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

-NoSSL [<SwitchParameter>]
If the environment is not set up for SSL, API calls will be made via HTTP not HTTPS (Not Recommended!)

Required: false
Position: 10
Default value: False
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:

$CCPResults = Invoke-VPASCentralCredentialProvider -ApplicationID {APPLICATION ID VALUE} -Safe {SAFE VALUE} -ObjectName {OBJECT NAME VALUE} -Folder {FOLDER VALUE} -CCPServer {CCPSERVER VALUE}

$CCPResults = Invoke-VPASCentralCredentialProvider -ApplicationID {APPLICATION ID VALUE} -Safe {SAFE VALUE} -ObjectName {OBJECT NAME VALUE} -Folder {FOLDER VALUE} -CCPServer {CCPSERVER VALUE} -CertificateTP {CERTIFICATE TP VALUE}


Outputs:

If successful:
{
         "Content": "SuperSecretPassword",
         "PolicyID": "WinDomain",
         "Name": "Operating System-WinDomain-vman.com-testdomainuser02",
         "LastTask": "ChangeTask",
         "UserName": "testdomainuser02",
         "CPMStatus": "success",
         "Safe": "NewSafeVpas",
         "Address": "vman.com",
         "LastSuccessVerification": "1723749510",
         "LastSuccessChange": "1723835924",
         "Folder": "Root",
         "DeviceType": "Application",
         "RetriesCount": "-1",
         "Object": "Operating System-WinDomain-vman.com-testdomainuser02",
         "CreationMethod": "PVWA",
         "PasswordChangeInProcess": "False"
}

$false if failed