Update Safe

This method updates a single Safe in the Vault. The user who runs this web service requires the following permissions:

In the Vault:

Manage Safes

In the Safe:

View Safe Members

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}

The following mandatory value is required in the URL:

Parameter

SafeName

Type

String

Description

The name of the Safe to update.

Valid values

Safe name

Resource information

HTTP method

PUT

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.

Body parameters

 
{
  "safe":{
    "SafeName":"<The name of the Safe>",
    "Description":"<Description of the Safe>",
    "OLACEnabled":<true/false>,
    "ManagingCPM":”<Name of CPM user managing the Safe>”,
    "NumberOfVersionsRetention":<1-999>,
    "NumberOfDaysRetention":<1-3650>
  }
}

 

Parameter

SafeName

Type

String

Description

The new name of the Safe, if you want to change it.

  • Specify up to 28 characters.
  • The following characters aren’t allowed: \/:*<>".|
  • Do not start a Safe name with a space.

Valid values

Safe name.

Parameter

Description

Type

String

Description

The updated description of the Safe.

Valid values

Up to100 characters

Parameter

OLACEnabled

Type

Boolean

Description

Whether or not to enable Object Level Access Control.

Valid values

true/false

Parameter

ManagingCPM

Type

String

Description

Name of the CPM user who will manage the Safe.

Valid values

An existing CPM user or "" to prevent the CPM from managing the Safe.

Parameter

NumberOf VersionsRetention

Type

Numeric

Description

The number of versions of every password that is stored in the Safe.

Specify either this parameter or NumberOfDaysRetention.

If you specify this parameter, the NumberOfDaysRetention parameter is disabled.

Valid values

1-999

Parameter

NumberOf DaysRetention

Type

Numeric

Description

The number of days that versions are stored in the Safe.

Specify either this parameter or NumberOfVersionsRetention. If you specify this parameter, the NumberOfVersionsRetention parameter is disabled.

Valid values

1-3650

Result

 
{
  "Safe":{
    "SafeName":"<The name of the Safe>",
    "Description":"<Description for the Safe>",
    "OLACEnabled":<true/false>,
    "ManagingCPM":"<Name of CPM user managing the Safe>",
    "NumberOfVersionsRetention":<1-999>,
    "NumberOfDaysRetention":<1-3650>
  }
}

Return codes

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