Passwordstate Documentation

Retrieving Security Groups ​

GET /userapi/securitygrouplocal/getsecuritygroup

You can retrieve one or more Local Security Groups, with a simple GET request. Below are examples of how to retrieve all Local Security Groups, or search for specific Security Groups.

Powershell
# PowerShell Request - Return all Security Groups
$PasswordstateUrl = 'https://passwordstate/userapi/securitygrouplocal/getsecuritygroups/'
Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -Header @{ "UserID" = "<UserID>" ; "APIKey" = "<APIKey>" }

# PowerShell Request - Search for Security Groups
$PasswordstateUrl = 'https://passwordstate/userapi/securitygrouplocal/getsecuritygroups/?search=finance'
Invoke-Restmethod -Method GET -Uri $PasswordstateUrl -Header @{ "UserID" = "<UserID>" ; "APIKey" = "<APIKey>" }
Json
# Response
HTTP/1.1 200          
[
    {
     "SecurityGroupID":  195,
     "SecurityGroupName":  "Finance Team",
     "Description":  "", 
     "ADSecurityGroup":  "True", 
     "ADDomainNetBIOS":  "mydomain", 
     "ObjectSID":  "S-1-5-21-1148196639-3763766589-299460394-7760",
     "SiteID":  0,
     "SiteLocation":  "Internal"
    }
]