Get Safe details

This method returns information about a specific Safe in the Vault.

Select the method that you want to use:

URL

 

 
https://<IIS_Server_Ip>//PasswordVault/api/Safes/{SafeUrlId}/
 

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

URL parameter

  
https://localhost/passwordvault/api/safes/HRSafe/members/Jill/

Parameter

Description

SafeUrlId

The unique ID of the Safe.

Type: String

Mandatory: Yes

Default value: None

includeAccounts

Whether or not to return accounts for each Safe as part of the response. If not sent, the value will be False.

Type: Boolean

Mandatory: No

Default value: False

useCache

Whether or not to retrieve the cache from a session.

Type: Boolean

Mandatory: No

Default value: False

Body parameters

None.

Result

  
{
"safeUrlId": "HRSafe",
"safeName": "HRSafe",
"safeNumber": 687,
"description": "HRSafe_Desc",
"location": "\\",
"creator": {
"id": "2",
"name": "Administrator"
},
"olacEnabled": false,
"managingCPM": "",
"numberOfVersionsRetention": null,
"numberOfDaysRetention": 6,
"autoPurgeEnabled": false,
"creationTime": 1621412613,
"lastModificationTime": 1622361852859451,
"accounts": [],
"isExpiredMember": false
}

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 Vaultt.

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: Integer

numberOfDaysRetention

The number of days that password versions are saved in the Safe.

Type: Integer

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

URL

 

Make sure there are no spaces in the URL.

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

 

  
https://<IIS_Server_Ip>/PasswordVault/WebServices/PIMServices.svc/Safes/{SafeName}

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

URL parameter

Parameter

Description

SafeName

The name of the Safe that information is returned for.

Type: String

Mandatory: Yes

Default value: None

Body parameters

None.

Result

  
{
"GetSafeResult": {
"Description":"HRSafe_Desc",
"ManagingCPM":"PasswordManager",
"NumberOfDaysRetention":5,
"NumberOfVersionsRetention":10,
"OLACEnabled":false,
"SafeName":"HRSafe"
}
}

Return codes

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