Search for a Safe

This method returns information about the Safes in the Vault that meet the criteria specified in the search query. It is demonstrated in the sample code.

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/WebServices/PIMServices.svc/Safes?query={Query}/

The following mandatory value is required in the URL:

Parameter	Query
Type	String
Description	The search query.

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

{
"SearchSafesResult":[ :{
"SafeName":"<Safe name>",
"Description":"<Description>",
"OLACEnabled":<true/false>,
"ManagingCPM":"<CPM user>",
"NumberOfVersionsRetention":<1-999>,
"NumberOfDaysRetention":<1-3650>
},
},
…
]
}

Return codes

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