Add Safe

This method adds a new Safe to the Vault.

The user who runs this web service requires Add Safes permissions in the Vault.

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

Resource information

HTTP method

POST

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":"<Safe name>",
"Description":"<Description>",
"OLACEnabled":<true/false>,
"ManagingCPM":"<CPM user>",
"NumberOfVersionsRetention":<1-999>,
"NumberOfDaysRetention":<1-3650>
  }
}

 

Parameter

SafeName (mandatory)

Type

String

Description

Name of a Safe to create.

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

Valid values

New Safe name

Parameter

Description

Type

String

Description

Description of the new Safe.

Valid values

Up to 100 characters.

Parameter

OLACEnabled

Type

Boolean

Description

Whether or not to enable Object Level Access Control for the new Safe.

Valid values

true/false

Parameter

ManagingCPM

Type

String

Description

The name of the CPM user who will manage the new 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 retained 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 for which password versions are saved 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 new Safe>",
    "Description":"<Description for the new 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.