Endpoint: /sites/{siteId}/user-groups

Note: Available as of EFT 8.1.0

Provides the ability to return a .list of user groups for a specific EFT site or create a new permission group.

  • GET

  • POST

Method & URL

GET https://[server URL]:[port]/admin/v2/sites/{siteId}/user-groups

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 

Method & URL

POST https://[server URL]:[port]/admin/v2/sites/{siteId}/user-groups

POST Body Sample

Copy 
### Create User Permission Group ###
POST https://{{host}}/admin/v2/sites/{{Siteid}}/user-groups HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
    "data": {
        "type": "userGroup",
        "attributes": {
            "name": "QA_API_User_Group_TEST"
        }
    }
}

POST Response Body Sample

Copy 
{ "data": { "type": "userGroup", "id": "1ba8c63f-6e37-4783-b556-be5bf831dc6c", "attributes": { 
"name": "QA_API_User_Group_TEST" }, "relationships": { "users": { "data": [] } }, "links": { 
"self": "/admin/v2/sites/c7d3ecfe-a100-4bcd-b830-01a10524c048/user-groups/1ba8c63f-6e37-4783-b556-be5bf831dc6c" } } }

POST PowerShell Sample

Copy 
#POST New Permission Group
Write-Output "POST User Permissions Group (New Permission Group)"
Write-Output "-----"
$update = 
'{
  "data": {
        "type": "userGroup",
        "attributes": {
            "name": "QA_API_User_Group_TEST"
        }
    }
}'

$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 10
$patchReturn = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/user-groups" 
-Method 'POST' -Headers $authHeader -Body $update