Add application

This method adds a new application to the Vault.

The user who adds this application requires Manage Users permission 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/Applications 

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

 
{
  "application":{
    "AppID":"<application Name>",
    "Description":"<description of the application>",
    "Location":"<existing location from the Vault>”,
    "AccessPermittedFrom":<the hour that access is permitted to the application>,
    "AccessPermittedTo":<the hour that access is permitted to the application>,
    "ExpirationDate":<expiration date of the application>,
    "Disabled":"<whether the application is disabled>",
    "BusinessOwnerFName":"<business owner first name>",
    "BusinessOwnerLName":"<business owner last name >",
    "BusinessOwnerEmail":"<business owner email >",
    "BusinessOwnerPhone":"<business owner phone>"
  }
}

 

Parameter

AppID (mandatory)

Type

String

Description

Application name.

 
  • Specify fewer than 128 characters.
  • Do not include ampersand (“&”).
  • Application names can include @, but a search for applications cannot include this character.

Valid values

Not empty

Parameter

Description

Type

String

Description

Description of the application.

 

Specify up to 29 characters.

Valid values

-

Parameter

Location

Type

String

Description

Location of the application in the Vault hierarchy.

 

To insert a backslash in the location path, use a double backslash.

Valid values

-

Parameter

AccessPermittedFrom

Type

Integer

Description

The hour that access is permitted to the application

Valid values

0-23

Parameter

AccessPermittedTo

Type

Integer

Description

The hour that access is permitted to the application

Valid values

0-23

Parameter

ExpirationDate

Type

String

Description

The date when the application expires.

Valid values

mm-dd-yyyy

Parameter

Disabled

Type

Boolean

Description

Whether the application is disabled.

Valid values

true/false

Default

false

Parameter

BusinessOwnerFName

Type

String

Description

The first name of the business owner.

 

Specify up to 29 characters.

Valid values

 

Parameter

BusinessOwnerLName

Type

String

Description

The last name of the business owner.

Valid values

-

Parameter

BusinessOwnerEmail

Type

String

Description

The email of the business owner.

Valid values

 

Parameter

BusinessOwnerPhone

Type

String

Description

The phone number of the business owner.

 

Specify up to 24 characters.

Valid values

Business owner's phone number.

Result

None

Return codes

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