Endpoint: /server/admin-users-policy

Returns EFT admin user policies such as account and password policy. Additionally, the PATCH request allows updates to the EFT admin policies.

Method & URL

GET https://[server URL]:[port]/admin/v2/server/admin-users-policy

GET Body Sample

Copy 
GET https://{{host}}/admin/v2/admin-users-policy HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

GET Response Body Sample

Copy 
{ "data": { 
"id": "1", 
"type": "adminUserPolicy", 
"attributes": { 
"accountPolicy": { 
"invalidLogin": { 
"account": { 
               "enabled": false, 
               "attemptPeriodMinutes": 5,  
               "attemptRetries": 5, 
               "lockoutMinutes": 30 }
               }, 
 "inactivity": {
 "disconnectDueToTimeout": { 
 "enabled": false, "timeoutMinutes": 5},"removeInactiveAccounts": {"enabled": false,  maxInactiveDays": 90}
 }
 },   
               "passwordPolicy": {         
               "complexity": {   
               "enabled": false,  
               "minLength": 8,            
               "userNameSimilarity": {             
               "enabled": true,             
               "maxAllowedChars": 3 }, 
               "repeatingCharLimit": { 
               "enabled": true, 
               "maxAllowedChars": 3 }, 
               "characterCategories": { "enabled": true, "characterCount": 4, "numericRequired": true, 
               "upperCaseRequired": true, "lowerCaseRequired": true, "nonAlphaNumericRequired": false, 
               "non7bitAsciiRequired": false }, "forbiddenDictionary": { "enabled": true,
               "backwardsWordsAllowed": false, "dictionaryFilePath": "" } }, 
               "forceResetAfterFirstLogin": false, "history": { "enabled": false, "historyDepth": 4 }, 
               "reset": { "expiration": { "enabled": false, "daysToExpire": 90 } } } } }, "links": { 
               "self": "admin/v2/admin-users-policy" } 
   }

GET PowerShell Sample

Copy 
###
#GET Server Admin user policy
Write-Output "Get Server Admin User Policy"
Write-Output "-----"
$serverAdminDetails = Invoke-RestMethod -Uri "$baseURL/v2/admin-users-policy" -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-policy

PATCH Body Sample

Copy 
PATCH https://{{host}}/admin/v2/admin-users-policy HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
  "data": {
    "id": "1",
    "type": "adminUserPolicy",
    "attributes": {
      "accountPolicy": {
          "inactivity": {
          "disconnectDueToTimeout": {
            "enabled": false,
            "timeoutMinutes": 5
          }

        }
      }
    }
  }
} 

PATCH PowerShell Sample

Copy 
###
#PATCH Server Admin user policy (disable Admin UI disconnect)
Write-Output "Server Admin User Policy Patch"
Write-Output "-----"
$update = 
'{
  "data": {
    "id": "1",
    "type": "adminUserPolicy",
    "attributes": {
      "accountPolicy": {
          "inactivity": {
          "disconnectDueToTimeout": {
            "enabled": false,
            "timeoutMinutes": 5
          }

        }
      }
    }
  }
}'   
$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 10
$patchReturn = Invoke-RestMethod -Uri "$baseURL/v2/admin-users-policy" 
-Method 'PATCH' -Headers $authHeader -Body $update