Endpoint: /server/admin-users/{adminId}

Returns EFT admin user (adminID required) information, which allows PATCH (update) and DELETE of admin user. To obtain the admin user ID a GET request will need to be done against the /admin-users endpoint prior to making this REST API request.

  • GET
  • PATCH
  • DELETE

Method & URL

GET https://[server URL]:[port]/admin/v2/server/admin-users/{adminID}

GET Body Sample

Copy 
GET https://{{host}}/admin/v2/admin-users/59774c12-870d-5560-a44a-c5b35cf68d4c HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

GET Response Body Sample

Copy 
{ 
"data": { 
  "id": "59774c12-870d-5560-a44a-c5b35cf68d4c", 
  "type": "adminUser", 
  "attributes": { 
    "adminConsolePermissions": { 
      "accountPolicy": "Server", 
      "enableCom": true, 
      "enableEditingAndReporting": true, 
      "enablePersonalDataAccess": true 
     }, 
     "name": "admin", 
     "restPermissions": { 
       "enabled": true, 
       "restAdminRole": "server_full_access" 
     } 
   } 
 }, 
 "links": { 
   "self": "admin/v2/admin-users/59774c12-870d-5560-a44a-c5b35cf68d4c" 
 } 
}

GET PowerShell Sample

Copy 
#Get Server Admin Details when providing a Server Admin ID
Write-Output "Get Server Admin Details"
Write-Output "-----"
$serverAdminDetails = Invoke-RestMethod -Uri 
"$baseURL/v2/admin-users/59774c12-870d-5560-a44a-c5b35cf68d4c" 
-Method 'GET' -Headers $authHeader
Write-Output $serverAdminDetails | ConvertTo-Json -Depth 10
foreach ($server in $serverAdminDetails.data)
{
    Write-Output ("Server $($serverAdminDetails.data)") 
}

Method & URL

PATCH https://[server URL]:[port]/admin/v2/server/admin-users/{adminID}.

PATCH Body Sample

Copy 
@adminID = 13564c1b-8e13-4e72-b8e0-9480fad06221
PATCH https://{{host}}/admin/v2/admin-users/{{adminID}} HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
  "data": {
    "id": "0",
    "attributes": {
        "adminConsolePermissions": {
        "enableCom": false,
        "enableEditingAndReporting": true,
        "enablePersonalDataAccess": true
      },
      "restPermissions": {
        "enabled": true,
        "restAdminRole": true
      }
    }
  }
}

PATCH PowerShell Sample

Copy 
###
#PATCH Server Admin Details when providing a Server Admin ID
Write-Output "Server Admin User Patch"
$adminID = "13564c1b-8e13-4e72-b8e0-9480fad06221"
Write-Output "Admin ID: $adminID"
Write-Output "-----"
$update = 
'{
  "data": {
    "id": "0",
    "attributes": {
        "adminConsolePermissions": {
        "enableCom": false,
        "enableEditingAndReporting": true,
        "enablePersonalDataAccess": true
      },
      "restPermissions": {
        "enabled": true,
        "restAdminRole": true
      }
    }
  }
}'
$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 10
$patchReturn = Invoke-RestMethod -Uri "$baseURL/v2/admin-users/$adminID" 
-Method 'PATCH' -Headers $authHeader -Body $update

Method & URL

DELETE https://[server URL]:[port]/admin/v2/server/admin-users/{adminID}.

DELETE Body Sample

Copy 
@adminID = 13564c1b-8e13-4e72-b8e0-9480fad06221
DELETE https://{{host}}/admin/v2/admin-users/{{adminID}} HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

DELETE PowerShell Sample

Copy 
###
#DELETE EFT admin by Admin ID
Write-Output "Server Admin DELETE"
$adminID = "f98d2a35-4d37-4891-89ed-66cb6ddf9436"
Write-Output "Admin ID: $adminID"
Write-Output "-----"
$serverAdminDetails = Invoke-RestMethod -Uri "$baseURL/v2/admin-users/$adminID" -Method 'DELETE' -Headers $authHeader
Write-Output $serverAdminDetails | ConvertTo-Json -Depth 10
foreach ($server in $serverAdminDetails.data)
{
    Write-Output ("Server $($serverAdminDetails.data)")
}