Endpoint: /server/admin-users
Returns list of EFT admin users and creates new admin users.
-
GET
Method & URL
GET https://[server URL]:[port]/admin/v2/server/admin-users
GET Body Sample
Copy
GET https://{{host}}/admin/v2/admin-users HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}GET Response Body Sample
Copy
{
"data": [
{
"id": "59774c12-870d-5560-a44a-c5b35cf68d4c",
"type": "adminUser",
"attributes": {
"name": "admin"
}
},
{
"id": "b76a1d7b-c3ad-5ac4-8636-06ce71ba3af3",
"type": "adminUser",
"attributes": {
"name": "Local computer\\Administrators"
}
}
],
"links": {
"self": "admin/v2/admin-users"
}
}GET POWERSHELL SAMPLE
Copy
#get Server admin users
Write-Output "Get Server admin users"
Write-Output "-----"
$serverAdmins = Invoke-RestMethod -Uri "$baseURL/v2/admin-users" -Method 'GET' -Headers $authHeader
Write-Output $serverAdmins | ConvertTo-Json
foreach ($server in $serverAdmins.data)
{
Write-Output ("Server $($serverAdmins.data)")
}
POST https://[server URL]:[port]/admin/v2/server/admin-users
POST Body Sample
Copy
POST https://{{host}}/admin/v2/admin-users HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
{
"data": {
"attributes": {
"name": "Test_admin2",
"password": "test",
"adminConsolePermissions": {
"accountPolicy": "server",
"enableCom": true,
"enableEditingAndReporting": true,
"enablePersonalDataAccess": true
},
"restPermissions": {
"enabled": true,
"restAdminRole": true
}
}
}
}POST Response Body Sample
Copy
HTTP/1.1 201 Created Date: Tue, 09 Aug 2022 18:18:00 GMT Content-Type: application/vnd.api+json ETag: "BF7E8C0E"
Content-Length: 394 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
{ "data":
{ "id": "9693cbcf-d4a9-49ac-aa1c-59efd91a692b", "type": "adminUser", "attributes": { "adminConsolePermissions": {
"accountPolicy": "Server", "enableCom": true, "enableEditingAndReporting": true, "enablePersonalDataAccess": true },
"name": "Test_admin2", "restPermissions": { "enabled": true, "restAdminRole": "server_full_access" } } }, "links": {
"self": "/admin/v2/admin-users/9693cbcf-d4a9-49ac-aa1c-59efd91a692b" } }
POST PowerShell Sample
Copy
#POST Server Admin user (New User)
Write-Output "POST Server Admin (New Admin user)"
Write-Output "-----"
$update =
'{
"data": {
"id": "1",
"attributes": {
"name": "Test_admin",
"password": "test",
"adminConsolePermissions": {
"accountPolicy": "server",
"enableCom": true,
"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" -Method 'POST' -Headers $authHeader -Body $update