Reporting

With the use of a Reporting API key, all of the reports found on the screen Administration -> Passwordstate Administration -> Reporting can also be run via the API.

The Reporting API key can be found on the screen Administration -> Passwordstate Administration -> System Settings -> API Keys tab.

Reporting Parameters

Each of the various reports listed in the table below this parameters section, can have one or more parameters specified to filter the results. The parameters are specified in the URL itself, and the API Key must be specified as a Header Attribute in the API Call - as per the PowerShell example below:

# PowerShell Request
$PasswordstateUrl = "https://passwordstate/api/reporting/<ReportID>?SiteID=<SiteID>"

$result = Invoke-RestMethod -Uri $PasswordstateUrl -Method GET -Header @{ "APIKey" = "<apikey>" }
Write-Host $result

Heading	Data Type	Description
ReportID	Integer	The ID of the Report, as documented below in the table.
SiteID	Integer	If you leave this parameter blank, it will report data based on all Site Locations. Values are 0 for Internal, and all other SiteID's can be found on the screen Administration -> Remote Site Administration -> Remote Site Locations.
UserID	String	The value of UserID which can been seen on the screen Administration -> Passwordstate Administration -> User Accounts.
SecurityGroupName	String	The name of the Security Groups which can been seen on the screen Administration -> Passwordstate Administration -> Security Groups.
Duration	Integer	The period in which data can be reported against. Possible values are 0 for current month, 1 for the past 30 days, and then any other integer representing the quantity of months. For the 'What passwords are expiring soon?' report however, Duration refers to the number of days you wish to look ahead for passwords which are going to expire.
PasswordListIDs	Integer	This parameter is only used for the 'What passwords are expiring soon?' report. The value of PasswordListID which can been seen on the screen Administration -> Passwordstate Administration -> Password Lists. You can also specify multiple PasswordListID's here by comma separating them.
QueryExpiredPasswords	Boolean	Used for the 'What passwords are expiring soon?' Report to indicate whether you also wish to report on passwords which have already expired, instead of just the passwords which are about to expire.

Reporting Details and Supported Parameters

Category	Report ID	Report Name	Parameters
User Reports	1	What passwords can a user see?	UserID
	2	What passwords does a user still know?	UserID, SiteID
	3	What has a user been doing lately?	UserID, Duration
	4	What Failed login attempts have there been?	UserID, SiteID, Duration
	5	Who hasn't logged in recently?	Duration
	6	Who has one or more Security Administrator roles?
	7	What Remote Sessions has a user been doing lately?	UserID, SiteID, Duration
	8	What user accounts are currently disabled?
	9	What user accounts are set to expire?
	10	Which users have logged in using the Emergency Access account?	Duration
	11	What user account impersonation has been occurring?	Duration
	41	What authentication option is applied for each user?	SiteID
Passwords	12	What passwords have failed Heartbeat?	SiteID
	13	What passwords have failed Reset?	SiteID
	14	What passwords require checkout?	SiteID
	15	What passwords are currently checked out?	SiteID
	16	What passwords require a Reason to be specified for access?	SiteID
	17	What passwords are expiring soon?	Duration, PasswordListIDs, QueryExpiredPasswords
	18	What passwords have recently been reset?	SiteID SiteID, Duration
	19	What password values have been reused?	SiteID
	20	What Passwords are not being synced?What passwords have not been used lately?	SiteID
	21	What Passwords are not being synced?	SiteID
	36	Show Passwords configured for resets and their dependencies	SiteID
	22	Passwords Strength Compliance Status	SiteID
	35	Have I Been Pwned Compromises
Permissions	23	What permissions exist (all users and security groups)?	SiteID
	24	What permissions exist for a user?	SiteID, UserID
	25	What Permissions exist for a Security Group?	SiteID, SecurityGroupName
	26	What permissions have changed recently?	Duration
	43	What permissions exist for all shared password records?	SiteID
	44	What permissions exist for all Host Folders?	SiteID
	27	Who has been approved access to passwords recently?	Duration
	28	Who has been denied access to passwords recently?	Duration
	37	How many Administrators are there for each Shared Password List?	SiteID
	38	How many Administrators are there for each Password Folder?	SiteID
Activity	29	Remote Session Launcher Activity	Duration
	30	Browser Extension Activity	Duration
	31	Mobile App Activity	Duration
	32	API Activity	Duration
	33	Self Destruct Activity	Duration
	34	Passive High Availability Module Activity	Duration
Document Reports	45	What documents have been uploaded into Password Folders?	SiteID
	46	What documents have been uploaded into Password Lists?	SiteID
	47	What documents have been uploaded into Password records?	SiteID
	48	What documents have been uploaded into Host Folders?	SiteID
	49	What documents have been uploaded into Host records?	SiteID
Misc Reports	39	Where are Privileged Account Credentials currently being used?	SiteID
	40	What security groups exist, and who are their members?	SiteID
	42	What Host records exist in Passwordstate?	SiteID