Update Safe

This method updates a single Safe in the Vault.

The user who runs this web service must have Manage Safes permissions in the Vault and View Safe Members permissions in the Safe.

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: + & %
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/

Resource information

HTTP method	Content type
PUT	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 parameter

Parameter	Description
safeUrlId	The unique ID of the Safe. Type: String Mandatory: Yes Default value: None

Parameter

Description

safeUrlId

The unique ID of the Safe.

Type: String

Mandatory: Yes

Default value: None

Body parameters

{
    "safeName":"Aviv",
    "safeNumber":22,
    "description":"AvivDesc",
    "location":"\\","creator":
    {
        "id":"14",
        "name":"AdminUser1"
    },
    "olacEnabled":false,
    "managingCPM":"PasswordManager",
    "numberOfVersionsRetention":null,
    "numberOfDaysRetention":7
}

Parameter	Description
safeName	The unique name of the Safe. The following characters cannot be used in the Safe name: \ / : * < > . \| ? “% & + Type: String Mandatory: Yes Default value: None
location	The location of the Safe in the Vault. Type: String Mandatory: No Default value: None
olacEnabled	Whether to enable Object Level Access Control for the new Safe. Type: Boolean Mandatory: No Default value: False If you set the default value to True, you cannot revert to False.
description	The description of the Safe. Type: String Mandatory: No Default value: ""
managingCPM	The name of the CPM user who will manage the new Safe. Type: String Mandatory: No Default value: None
numberOfVersionsRetention	The number of retained versions of every password that is stored in the Safe. Type: Integer Mandatory: No Default value: None
numberOfDaysRetention	The number of days that password versions are saved in the Safe. Type: Integer Mandatory: No Default value: None

Result

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 note 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: Long
lastModificationTime	The Unix time when the Safe was last updated. Type:Long
isExpiredMember	Whether or not the membership for the Safe is expired. For expired members, the value is True. Type: Boolean

Return codes

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