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

NOTE: Available as of EFT 8.1.0

Provides the ability to return a user group’s details, update a permission group name or delete a user group.

GET
PATCH
DELETE

Method & URL

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

GET Body Sample

Copy

### Get List of all User's Permissions Groups for the Site####
# @name UGlist
GET https://{{host}}/admin/v2/sites/{{Siteid}}/user-groups HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###
@groupid = {{UGlist.response.body.$.data[3].id}}

### GET Details for specific User Permission Group####
GET https://{{host}}/admin/v2/sites/{{Siteid}}/user-groups/{{groupid}} HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

GET Response Body Sample

Copy

{ "data": 
{ "type": "userGroup", "id": "7386d09b-ac9d-42c8-a7dd-8ffb840d58e3", "attributes": 
{ "name": "QA_API_User_Group_TEST" }, "relationships": 
{ "users": { "data": [] } }, "links": 
{ "self": 
"/admin/v2/sites/c7d3ecfe-a100-4bcd-b830-01a10524c048/user-groups/7386d09b-ac9d-42c8-a7dd-8ffb840d58e3"
} } }

GET PowerShell Sample

Copy

##########
#Get User Permission Groups
$userGroups = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/user-groups" 
-Method 'GET' -Headers $authHeader
foreach ($userGroups in $userGroups.id)
{
    Write-Output ("User Permission Group found:  
    $($userGroups.id): $($userGroups.attributes.name)")
}
$userGroupID = $userGroups.data[3].id


#Get Specific User Permission Group
Write-Output "Get Specific User Permission Group"
Write-Output "-----"
$userGroup = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/user-groups/$userGroupID" 
-Method 'GET' -Headers $authHeader
Write-Output $userGroup | ConvertTo-Json -Depth 10

Method & URL

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

PATCH Body Sample

Copy

### GET Details for specific User Permission Group####
GET https://{{host}}/admin/v2/sites/{{Siteid}}/user-groups/{{groupid}} HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

#### Update Name for Specific User Permissions Group
PATCH https://{{host}}/admin/v2/sites/{{Siteid}}//user-groups/{{groupid}} HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

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

PATCH Response Body Sample

Copy

{ "data": { "type": "userGroup", "id": "7386d09b-ac9d-42c8-a7dd-8ffb840d58e3", "attributes": 
{ "name": "QA_API_User_Group_TEST2" }, "relationships": 
{ "users": { "data": [] } }, "links": 
{ "self": 
"/admin/v2/sites/c7d3ecfe-a100-4bcd-b830-01a10524c048/user-groups/7386d09b-ac9d-42c8-a7dd-8ffb840d58e3" 
} } }

PATCH PowerShell Sample

Copy

#Get Specific User Permission Group
Write-Output "Get Specific User Permission Group"
Write-Output "-----"
$userGroup = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/user-groups/$userGroupID" 
-Method 'GET' -Headers $authHeader
Write-Output $userGroup | ConvertTo-Json -Depth 10

###
##Patch Specific User Permissions Group
Write-Output "User Permission Group Patch (update)"
Write-Output "-----"
$update = 
'{
   "data": {
    "type": "userGroup",
    "attributes": {
      "name": "QA_API_User_Group_TEST2"
    }
  }
}'
$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 10
$patchReturn = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/user-groups/$userGroupID" 
-Method 'PATCH' -Headers $authHeader -Body $update

Method & URL

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

DELETE Body Sample

Copy

### Delete Specific User Permission Group ###
Delete https://{{host}}/admin/v2/sites/{{Siteid}}//user-groups/{{groupid}} 
HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

DELETE Response Body Sample

Copy

HTTP/1.1 204 No Content Date: Fri, 22 Jul 2022 22:40:06 GMT Content-Length: 0 
Cache-Control: no-cache, no-store, must-revalidate Expires: -1 
X-Content-Type-Options: nosniff X-XSS-Protection: 1; mode=block 
Content-Security-Policy: default-src 'self' 'unsafe-inline' 'unsafe-eval' data:; 
Referrer-Policy: no-referrer

DELETE PowerShell Sample

Copy

#Get Specific User Permission Group
Write-Output "Get Specific User Permission Group"
Write-Output "-----"
$userGroup = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/user-groups/$userGroupID" 
-Method 'GET' -Headers $authHeader
Write-Output $userGroup | ConvertTo-Json -Depth 10

###
#DELETE Specific User Permission Group
Write-Output "Delete Specific User Permission Group"
Write-Output "-----"
$commandList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/user-groups/$userGroupID" 
-Method 'DELETE' -Headers $authHeader
Write-Output $commandList | ConvertTo-Json -Depth 10