PAS system health summary

This method returns consolidated information about the Vault, PVWA, CPM, PSM/PSM for SSH, and AAM Credential Providers, including all clients that are relevant to each specific component.

URL

 

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %

 

 

https://<IIS_Server_Ip>/PasswordVault/api/ComponentsMonitoringSummary

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, .

Result

For PVWA, CPM, PSM/PSM for SSH, and AAM Credential Providers:

 
{

"Components": [

{

"ComponentID": "<ComponentID>",

"ComponentName": "<ComponentName>",

"Description": "<Description>",

"ConnectedComponentCount": <number>,

"ComponentTotalCount": <number>,,

"ComponentSpecificStat": <number>,

}

]

 

Parameter

ComponentID

Type

String

Description

The ID of the component whose details are displayed.

Parameter

ComponentName

Type

String

Description

The name of the component whose details are displayed.

Parameter

Description

Type

String

Description

The type of information that will be displayed based on the relative component.

  • PVWA - active users

  • CPM - managed accounts

  • PSM/PSM for SSH - concurrent sessions

  • AAM Credential Providers - application IDs

Parameter

ConnectedComponentsCount

Type

The number of logged on component users for the relative component.

Description

Integer

Parameter

ComponentTotalCount

Type

Integer

Description

The total number of component users for the component type in the Vault.

Parameter

ComponentSpecificStat

Type

Integer

Description

Component type specific information:

  • PVWA - Number of active users

  • CPM - Number of managed accounts

  • PSM/PSM for SSH - Number of concurrent sessions

  • AAM Credential Providers - Number of application IDs

For Vaults:

 

"Vaults": [
{
"IP": "<IP>",
"Role": "<Role>",
"IsLoggedOn": <true/false>
}
]

 

Parameter

IP

Type

String

Description

The IP of the Vault server.

Parameter

Role

Type

String

Description

The role of the Vault.

In on-prem, active-passive deployments, one of the following values is displayed:

  • Primary

  • DR

In Distributed Vaults deployments, one of the following values is displayed:

  • Master

  • DR

Parameter

IsLoggedOn

Type

Boolean

Description

Whether or not the component user is currently logged on to the Vault and replicating to the DR Vault.

Return codes

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