Search Privileged Account Credential Permission

GET /api/privaccountpermissions

Searching for Privileged Account Credential permissions can be achieved via multiple criteria, as outlined by the fields below. You can search using just one field, or multiple to further narrow down the search results. You must specify the Privileged Account Credential API Key which can be found on the screen Administration -> Passwordstate Administration -> System Settings -> API tab.

• PrivilegedAccountID
• Description
• UserName
• SiteID
• SiteLocation
• UserID (this is the UserID found on the screen Administration -> User Accounts, which has permissions applied to Privileged Account Credentials for the user)
• SecurityGroupID (this is the SecurityGroupID found on the screen Administration -> Security Groups, which has permissions applied to Privileged Account Credentials for the Security Group)
• SecurityGroupName (this is the SecurityGroupName found on the screen Administration -> Security Groups, which has permissions applied to Privileged Account Credentials for the Security Group)

# Search by PrivilegedAccountID
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?PrivilegedAccountID=<value>'
                           
# Search by Description
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?Description=<value>'

# Search by UserName
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?UserName=<value>'

# Searching by SiteID
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?SiteID=<value>'

# Searching by SiteLocation
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?SiteLocation=<value>'

# Search by UserName and SiteLocation
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?UserName=<value>&SiteLocation=<value>'

# Search by permissions applied by UserID
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?UserID=<value>'

# Search by permissions applied by SecurityGroupID
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?SecurityGroupID=<value>'

# Search by permissions applied by SecurityGroupName
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?SecurityGroupName=<value>'

# Search by permissions applied to 'All Users and Security Groups'
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?UserID=All Users and Security Groups'
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?SecurityGroupID=All Users and Security Groups'
$PasswordstateUrl = 'https://passwordstate/api/privaccountpermissions/?SecurityGroupName=All Users and Security Groups'

Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -Header @{ "APIKey" = "<apikey>" }

# Response
HTTP/1.1 200          
[
    {
        "PrivilegedAccountID":"7",
        "Description":"AD Account for Priv Account Management",
        "UserName":"domain\ps_accnt",
        "PasswordID":"0",
        "AccountType":"Active Directory",
        "SiteID":"0",
        "SiteLocation":"Internal",
        "UserID":"",
        "SecurityGroupID":"239",
        "SecurityGroupName":"CoreAdmins"
    }
]