Endpoint: /sites/{siteId}/userGroups

Returns the user groups (such as Administrators or All Users) for specific site.

  • GET

Method & URL

GET https://[server URL]:[port]/admin/v2/sites/{siteId}/userGroups

GET Body Sample

Copy 
### GET the User groups Settings####
GET https://{{host}}/admin/v2/sites/{{Siteid}}/userGroups HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

GET Response Body Sample

Copy 
{ "data": [ { "attributes": { "name": "All Users" }, "id": "A0DB9377-92A3-4A38-8C0F-09F268D78FF1", 
"type": "userGroup" }, { "attributes": { "name": "Administrators" }, 
"id": "07CACEB2-6698-4EF7-BAEB-F437FEC972A2", "type": "userGroup" }, { "attributes": { "name": "Guests" }, 
"id": "B8448B77-01D8-47D5-8EE7-9F407C95E39F", "type": "userGroup" } ], 
"links": { "self": "admin/v2/sites/0de7387f-1506-427d-b997-e18bcdb8cbae/userGroups" } }

GET PowerShell Sample

Copy 
###GET User Groups###
Write-Output "GET User Groups"
Write-Output "-----------------"
#$siteID = "Enter site ID"
$Uglist = Invoke-RestMethod -Uri 
"$baseURL/v2/sites/$siteID/userGroups" -Method 'GET' 
-Headers $authHeader
Write-Output $Uglist | ConvertTo-Json -Depth 25