Get applications

This method returns a list of all the applications in the Vault.

The user who runs this web service requires Audit Users 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/Applications/

Add the following query values in the URL:

Parameter

AppID

Type

String

Description

Application name.

Valid values

Not empty

Parameter

Location

Type

String

Description

Location of the application in the Vault hierarchy.

Valid values

Location

Default

\

Parameter

IncludeSublocations

Type

Boolean

Description

Whether or not the search will be performed in sublocations of the specified location.

Valid values

true/false

Default

true

 

 
/PasswordVault/WebServices/PIMServices.svc/Applications?Location=%5CApplications&AppID=App-1

Resource information

HTTP method

GET

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

None

Result

 
{
 "application": [
      {
         "AccessPermittedFrom":<string>,
        "AccessPermittedTo":<string>,
         "AllowExtendedAuthenticationRestrictions":<bool>,
        "AppID":<string>,
        "BusinessOwnerEmail":"<string>",
        "BusinessOwnerFName":"<string>",
         "BusinessOwnerLName":"<string>",
        "BusinessOwnerPhone":"<string>",
         "Description":"<string>",
        "Disabled":<bool>,
         "ExpirationDate":<string>,
         "Location":"<string>"
      }]
}

Return codes

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