Get password value

This method enables users to retrieve the password or SSH key of an existing account that is identified by its Account ID. It enables users to specify a reason and ticket ID, if required.

To retrieve a private SSH key account, see the Retrieve private SSH key account REST API.

The ability to retrieve credentials using this REST API is intended for human use only and is not recommended for applications or automated processes, where application-based authentication is required. For application or automated processes use cases, see the Secrets Manager Credential Providers Docs.

Select the method you want to use:

2nd gen API (recommended)

URL

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %
If the URL includes a dot (.), add a forward slash (/) at the end of the URL. For example: api/Safes/MySafe/Members/user@cyber.com/

https://<IIS_Server_Ip>/PasswordVault/API/Accounts/{accountId}/Password/Retrieve/

The following mandatory value is required in the URL:

Parameter	AccountID
Type	String
Description	The unique ID of the account.
Valid values	Account ID

Resource information

HTTP method	POST
Content type	application/json

Header parameter

Parameter	Description
Authorization	The token that identifies the session, encoded in BASE 64. See Authentication. Type: String Mandatory: Yes Default value: None

Body parameters

{
reason:"<Reason>",
TicketingSystemName: "<Ticketing system>",
TicketId: "<Ticketid>",
Version: <version number>,
ActionType: "<action type - show\copy\connect>
isUse: <true\false>,
Machine: "<my remote machine address>"
}

Parameter	Reason
Type	String
Description	The reason that is required to retrieve the password/SSH key.
Valid values	-
Default	-
Parameter	TicketId
Type	String
Description	The ticket ID of the ticketing system.
Valid values	-
Default	-
Parameter	TicketingSystem
Type	String
Description	The name of the Ticketing System.
Valid values	-
Default	-
Parameter	IsUse
Type	Boolean
Description	Internal parameter (for PSM for SSH only).
Valid values	true/false
Default	false
Parameter	ActionType
Type	String
Description	The action this password will be used for.
Valid values	show/copy/connect
Default	-
Parameter	Machine
Type	String
Description	The address of the remote machine to connect to.
Valid values	-
Default	-
Parameter	Version
Type	integer
Description	The version number of the required password. If there are no previous versions, the current password/key version is returned.
Valid values	A positive number
Default	-

Result

"<myPassword>"

1st gen API

This web service does not return SSH Keys. If the request was sent for an SSK key, the following error will be returned: "Failed to get the credentials of <AccountID>. Reason: The account is of type SSH Key."
This web service is not able to retrieve the password if a reason is required (according to its effective Master Policy). An error will be returned.

URL

https://<IIS_Server_Ip>/PasswordVault/WebServices/PIMServices.svc/Accounts/{AccountID}/Credentials/

The following mandatory value is required in the URL:

Parameter	AccountID
Type	String
Description	The ID of the Account whose password will be retrieved.
Valid values	Account ID

Resource information

HTTP method	GET
Content type	application/json

Header parameter

Parameter	Authorization
Type	String
Description	The token that identifies the session.
Valid values	A session token that was returned from the “Logon” method.

Body parameters

None

Result

[
{
"Credentials":"VALUE"
}    ]

Return codes

For a complete list of return codes, see Return Codes.