Retrieve-Credential function
Use the Retrieve-Credential function to specify the endpoint URL of the third-party password vault and to pass in required data for authentication.
|
Variable Name |
Data Type |
Description |
|---|---|---|
|
PfxData |
Byte Array |
PKCS#12 keystore containing client certificate and private key for authenticating with the third-party vault; this and the PfxPass are used together to instantiate an X509Certificate2 object for client certificate authentication. |
|
PfxPass |
SecureString |
Password for access to the private key of the PfxData PKCS#12 |
|
Username |
String |
User name for authenticating with the vault |
|
Password |
String |
The password or Token required for authenticating with the vault |
|
VaultUrl |
String |
The vault endpoint URL |
|
Variable Name |
Data Type |
Description |
|---|---|---|
|
ConnectorDN |
Byte Array |
The DN of the Adaptable Credential Connector |
|
CredentialDN |
SecureString |
The DN of the Adaptable Credential |
|
CredentialType |
String |
A credential type (string) that the Adaptable Credential object will represent (e.g. "Password Credential", "Username Password Credential", "Certificate Credential", "Private Key Credential", "Amazon Credential") |
|
VarText1 |
String |
Value for the text this custom field defined by the header at the top of your script |
|
VarText2 |
String |
Value for the text this custom field defined by the header at the top of your script |
|
VarText3 |
String |
Value for the text this custom field defined by the header at the top of your script |
|
VarText4 |
String |
Value for the text this custom field defined by the header at the top of your script |
|
VarText5 |
String |
Value for the text this custom field defined by the header at the top of your script |
|
VarBool1 |
Boolean |
Value for the yes/no custom field defined by the header at the top of your script (true|false) |
|
VarBool2 |
Boolean |
Value for the yes/no custom field defined by the header at the top of your script (true|false) |
|
VarPass |
String |
Value for the text password custom field defined by the header at the top of your script |
|
Return |
Data Type |
Description |
|---|---|---|
|
Result |
String |
Shows "Success" to indicate the non-error completion state, or an error message if unsuccessful |
|
Password |
String |
The retrieved credential password |
|
Username |
String |
The retrieved credential user name |