Get all Safes

This method returns a list of all Safes in the Vault that the user has permissions for. To run this web user, the user must be a member of the Safes in the Vault that are returned in the list.

Select the method that you want to use:

2nd gen API (recommended)

URL

http://<IIS_Server_Ip>/PasswordVault/api/Safes

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %

Resource information

HTTP method	Content type
GET	application/json

Header parameter

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

Parameter

Description

Authorization

The token that identifies the session, encoded in BASE 64.

Type: String

Mandatory: Yes

Default value: None

URL parameters

https://localhost/PasswordVault/api/safes?includeAccounts=true&offset=8&limit=4

Parameter	Description
search	Searches according to the Safe name. Search is performed according to the REST standard (search="search word"). Type: String Mandatory: No Default value: None
offset	Offset of the first Safe that is returned in the collection of results. Type: Number Mandatory: No Default value: 0
limit	The maximum number of Safes that are returned. When used together with the offset parameter, this value determines the number of Safes to return, starting from the first Safe that is returned. Type: Number Mandatory: No Default value: 25
sort	Sorts according to the safeName property in ascending order (default) or descending order to control the sort direction. asc: ascending desc: descending Example: sort=safeName desc Type: String Mandatory: No Default value: None
includeAccounts	Whether or not to return accounts for each Safe as part of the response. If not sent, the value is False. Type: Boolean Mandatory: No Default value: False
extendedDetails	Whether or not to return all Safe details or only safeName as part of the response. If not sent, the value is True. Type: Boolean Mandatory: No Default value: True

Body parameters

None

Result

{
"value": [
{
"safeUrlId": "VaultInternal",
"safeName": "VaultInternal",
"safeNumber": 2,
"description": "",
"location": "\\",
"creator": {
"id": "2",
"name": "Administrator"
},
"olacEnabled": false,
"managingCPM": "",
"numberOfVersionsRetention": null,
"numberOfDaysRetention": 30,
"autoPurgeEnabled": false,
"creationTime": 1608827926,
"lastModificationTime": 1610319618268452,
"isExpiredMember": false
},
{
...
}

],
"count": 1769,
"nextLink": "api/safes?offset=25&limit=25&useCache=False"
}

Parameter	Description
Value	A list of all Safes returned. See Safe parameters.
Count	The number of Safes returned. Type: Integer
NextLink	An opaque URL to the next page of results. Type: String

Parameter

Description

Value

A list of all Safes returned. See Safe parameters.

Count

The number of Safes returned.

Type: Integer

NextLink

An opaque URL to the next page of results.

Type: String

Safe parameters

Parameter	Description
safeUrlId	The unique ID of the Safe used when calling Safe APIs. Type: String
safeName	The unique name of the Safe. Type: String
safeNumber	The unique numerical ID of the Safe. Type: Integer
description	The description of the Safe. Type: String
location	The location of the Safe in the Vault. Type: String
creator	Contains the following parameters: creator.id: The ID of the user that created this Safe creator.name: The name of the user that created this Safe Type: String
accounts	Contains the following parameters: account.id: The ID of the accounts that reside in this Safe account.name: The name of the accounts that reside in this Safe Type: String
olacEnabled	Whether or not to enable Object Level Access Control for the new Safe. Type: Boolean
managingCPM	The name of the CPM user who will manage the new Safe. Type: String
numberOfVersionsRetention	The number of retained versions of every password that is stored in the Safe. Type: Number
numberOfDaysRetention	The number of days that password versions are saved in the Safe. Type: Number
AutoPurgeEnabled	Whether or not to automatically purge files after the end of the Object History Retention Period defined in the Safe properties. Report Safes and PSM Recording Safes are created automatically with AutoPurgeEnabled set to Yes. These Safes cannot be managed by the CPM. Type: Boolean
creationTime	The Unix creation time of the Safe. Type: DateTime
lastModificationTime	The Unix time when the Safe was last updated. Type: DateTime
isExpiredMember	Whether or not the membership for the Safe is expired. For expired members, the value is True. Type: boolean

1st gen API

URL