Get account details

The user who runs this web service requires List Accounts permissions in the Safe where the account is located inside the Vault.

URL

https://<IIS_Server_Ip>/PasswordVault/API/Accounts/{id}/

The following mandatory value is required in the URL:

Parameter	id
Type	String
Description	The account's unique ID.
Valid values	Account ID

Resource information

HTTP method	GET
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

None

Result

{ "CategoryModificationTime": 1588049324, "id": "string", "name": "string", "address": "string", "userName": "string", "platformId": "string", "safeName": "string", "secretType": "key", "platformAccountProperties": {}, "secretManagement": { "automaticManagementEnabled": true, "manualManagementReason": "string", "status": "inProcess", "lastModifiedTime": 0, "lastReconciledTime": 0, "lastVerifiedTime": 0 }, "remoteMachinesAccess": { "remoteMachines": "string", "accessRestrictedToRemoteMachines": true }, "createdTime": 0 }

 

Parameter	id
Type	string
Description	The ID of the account.
Valid values	Valid account ID
Parameter	safeName
Type	string
Description	The Safe where the account is located.
Valid values	Safe name
Parameter	platformId
Type	string
Description	The platform assigned to this account.
Valid values	Valid platform IDs, example: WinServerLocal
Parameter	address
Type	string
Description	The name or address of the machine where the account is used.
Valid values	vDNS/IP/URL where the account is managed
Parameter	name
Type	string
Description	The name of the account.
Valid values	Account name
Parameter	secretType
Type	string
Description	The type of password.
Valid values	password, key
Parameter	username
Type	string
Description	The account user's name.
Valid values	User name
Parameter	platformAccountProperties
Type	string
Description	The object containing key-value pairs to associate with the account, as defined by the account platform. Optional properties that do not exist on the account will not be returned here. Internal properties are not returned.
Valid values	example: {"Location": "IT", "OwnerName": "MSSPAdmin"}
secretManagement Parameter automaticManagementEnabled Type Boolean Description Whether the account secret is automatically managed by the CPM. Default true Valid values true, false Parameter manualManagementReason Type string Description The reason for disabling automatic secret management. Valid values Reason. Parameter status Type string Description The account management status. Valid values inProcess, succeeded, failed, partiallySucceeded Parameter lastModifiedTime Type string Description The time the account was created, or when the secret (password or key) was modified. Valid values date-time Parameter lastReconciledTime Type string Description The last reconciled time of the account. Valid values date-time Parameter lastVerifiedTime Type string Description The last verified time of the account. Valid values date-time
remoteMachinesAccess Parameter remoteMachines Type string Description A list of remote machines, separated by semicolons. Example: server1.cyberark.com;server2.cyberark.com Valid values A list of machines. Parameter accessRestrictedToRemoteMachines Type Boolean Description Whether or not to restrict access only to specified remote machines Valid values true, false
Parameter	createdTime
Type	string
Description	The time the account was created, or when the secret (password or key) was modified.
Valid values	date-time
Parameter	CategoryModificationTime
Type	string
Description	The last time the account or one of its file categories was created or modified.
Valid values	date-time

This method returns information about an account. If more than one account meets the search criteria, only the first account will be returned, although the Count output parameter will display the number of accounts that were found.

Only the following users can access this account:

■

Users who are members of the Safe where the account is stored.

■

Users who have access to this specific account.

The user who runs this web service requires List accounts permission in the Safe:

This method does not display the actual password. If ten or more accounts are found, the Count Output parameter will show 10.

URL

 

https://<IIS_Server_Ip>/PasswordVault/WebServices/PIMServices.svc/Accounts

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.

Query parameters

The following parameters can be specified in the URL to filter the result:

Parameter	Keywords
Type	String
Description	Specify a keyword to search for. If you specify multiple keywords, the search will include all the keywords. Separate keywords with a space.
Valid values	Multiple keywords. Maximum of 500 characters.
Parameter	Safe
Type	String
Description	Specify the name of a Safe to search. The search will be carried out only in the Safes in the Vault that you are authorized to access.
Valid values	Maximum of 28 characters

Examples

The following example shows how to retrieve an account with address: 10.10.1.1, user: root, Safe: called UNIXAccountsSafe.

/PasswordVault/WebServices/PIMServices.svc/Accounts?Keywords=10.10.1.1,root&Safe =UNIXAccountsSafe

Body parameters

None

Result

Only the account properties that are currently defined will be returned.

 

{ "Count":<the number of accounts that were found>, "accounts":[ { "AccountID":"<ID of Account1>", "Properties": [ {"Key":"Safe", "Value":"<Account1’s safe name>"}, {"Key":"Folder", "Value":"<Account1’s folder name>"}, {"Key":"Name", "Value":"<The name of Account1>"}, {"Key":"UserName", "Value":"<The username of Account1>"}, {"Key":"Address", "Value":"<The address of Account1>"} ] "Internal Properties": [ {"Key":"CPMInternal", "Value":"<Account1’s CPM’s internal reason>"}, {"Key":"ResetImmediately", "Value":"<ChangeTask, VerifyTask or ReconcileTask>"}, {"Key":"NoGenerate", "Value":"<…>"} ] } ] }

 

Parameter	Count
Type	Integer
Description	The number of accounts that were found by the requested query.
Parameter	AccountID
Type	Integer
Description	The account's unique ID.
Parameter	Safe
Type	String
Description	The name of the Safe where the account is stored.
Parameter	Folder
Type	String
Description	The name of the folder where the account is stored.
Parameter	Name
Type	String
Description	The name of the account.
Parameter	Additional account properties that are defined, including internal properties.