Endpoint: /sites/{siteId}/accountSecurity

Returns and updates account security configuration for specific profile

GET
PATCH

Method & URL

GET https://[server URL]:[port]/admin/v2/sites/{siteId}/sms/accountSecurity

GET Body Sample

Copy

### GET Account Security Settings####
GET https://{{host}}/admin/v2/sites/{{Siteid}}/accountSecurity/ HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

GET Response Body Sample

Copy

{
  "data": {
    "type": "siteSecurity",
    "id": "0de7387f-1506-427d-b997-e18bcdb8cbae",
    "attributes": {
      "accountPolicy": {
        "invalidLogin": {
          "ip": {
            "enabled": true,
            "attemptPeriodMinutes": 1,
            "attemptRetries": 5,
            "inCorrectLoginType": "NameOnly"
          },
          "account": {
          }
        },
        "inactivity": {
        },
        "personalDetailsConfiguration": [
        ]
      },
      "passwordPolicy": {
        "complexity": {
        },
        "PersistCredentialsForEventRuleContextVariable": true,
        "suppressForgotPwd": {
        },
        "emailLoginCredentials": {
        },
        "history": {
        },
        "reset": {
        }
      }
    }
  },
  "links": {
  }
}

GET PowerShell Sample

Copy

####Added 2/09/2022 ### 
### GET Account Security Configuration Details ###
Write-Output "GET Account Security Configuration Details"
Write-Output "----"
$profileName = "PowerShell Example"
$smsList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/accountSecurity" -Method 'GET' -Headers $authHeader
Write-Output $smsList | ConvertTo-Json -Depth 25

Method & URL

PATCH https://[server URL]:[port]/admin/v2/sites/{siteId}/sms/accountSecurity

PATCH Body Sample

Copy

### PATCH Account Security Settings ###
PATCH https://{{host}}/admin/v2/sites/{{Siteid}}/accountSecurity/ HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
{
  "data": {
    "attributes": {
      "accountPolicy": {
        "invalidLogin": {
          "account": {
            "enabled": true,
            "action": "Lockout",
            "attemptPeriodMinutes": 10,
            "attemptRetries": 10,
            "lockoutMinutes": 10
          },
          "ip": {
            "enabled": true,
            "attemptPeriodMinutes": 10,
            "attemptRetries": 10,
            "inCorrectLoginType": "NameOrPassword"
          }
        },
        "inactivity": {
          "removeInactiveAccounts": {
            "enabled": true,
            "action": "Delete",
            "maxInactiveDays": 10
          }
        },
        "reset": {
          "enabled": true,
          "forceResetAfterFirstLogin": true,
          "expiration": {
            "enabled": true,
            "emailUpon": true,
            "daysToExpire": 10,
            "reminderPrior": {
              "enabled": true,
              "daysBefore": 10,
              "emailUser": true
            }
          }
        }
      }
    }
  }
}

PATCH Response Body Sample

The response will return the same response as the GET request, however, it will now include the updated Patch request(s).

Copy

{ "data": { "type": "site", "id": "0de7387f-1506-427d-b997-e18bcdb8cbae", "attributes": { 
"accountPolicy": { "invalidLogin": { "ip": { "enabled": true, "attemptPeriodMinutes": 5, 
"attemptRetries": 5, "inCorrectLoginType": "NameOrPassword" }, "account": { "enabled": true, 
"action": "Disable", "attemptPeriodMinutes": 11, "attemptRetries": 5, "lockoutMinutes": 5 } }, 
"inactivity": { "removeInactiveAccounts": { "enabled": true, "action": "Delete", "maxInactiveDays": 
10 } }, "personalDetailsConfiguration": [ { "id": "Email", "displayName": "Email", "defaultValue": 
"", "isEnabled": true, "isPersonalData": true, "isModifiable": true, "isVisibleToUser": true }, { 
"id": "FullName", "displayName": "Full Name", "defaultValue": "", "isEnabled": true, 
"isPersonalData": true, "isModifiable": true, "isVisibleToUser": true }, { "id": "CompanyName", 
"displayName": "Company Name", "defaultValue": "", "isEnabled": true, "isPersonalData": false, 
"isModifiable": true, "isVisibleToUser": false }, { "id": "Mobile", "displayName": "Mobile", 
"defaultValue": "", "isEnabled": true, "isPersonalData": true, "isModifiable": true, 
"isVisibleToUser": true }, { "id": "Description", "displayName": "Description", "defaultValue": 
"", "isEnabled": true, "isPersonalData": false, "isModifiable": true, "isVisibleToUser": false 
}, { "id": "Phone", "displayName": "Phone", "defaultValue": "", "isEnabled": true, "isPersonalData": 
true, "isModifiable": true, "isVisibleToUser": true }, { "id": "Fax", "displayName": "Fax", 
"defaultValue": "", "isEnabled": true, "isPersonalData": true, "isModifiable": true, "isVisibleToUser": 
true }, { "id": "Pager", "displayName": "Pager", "defaultValue": "", "isEnabled": true, 
"isPersonalData": true, "isModifiable": true, "isVisibleToUser": true }, { "id": "Duns", 
"displayName": "DUNS", "defaultValue": "", "isEnabled": true, "isPersonalData": false, "isModifiable": 
true, "isVisibleToUser": false }, { "id": "PartnerId", "displayName": "Partner ID", "defaultValue": "", 
"isEnabled": true, "isPersonalData": false, "isModifiable": true, "isVisibleToUser": false }, { 
"id": "Custom1", "displayName": "Custom 1", "defaultValue": "", "isEnabled": true, 
"isPersonalData": false, "isModifiable": true, "isVisibleToUser": false }, { "id": "Custom2", 
"displayName": "Custom 2", "defaultValue": "", "isEnabled": true, "isPersonalData": false, 
"isModifiable": true, "isVisibleToUser": false }, { "id": "Custom3", "displayName": "Custom 3", 
"defaultValue": "", "isEnabled": true, "isPersonalData": false, "isModifiable": true, "isVisibleToUser": 
false }, { "id": "Comments", "displayName": "Comments", "defaultValue": "", "isEnabled": true, 
"isPersonalData": false, "isModifiable": true, "isVisibleToUser": false } ] }, "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": "" } }, "PersistCredentialsForEventRuleContextVariable": true, 
"suppressForgotPwd": { "enabled": false, "domainType": "All Domains" }, "emailLoginCredentials": 
{ "enabled": true, "emailOptions": "Both" }, "history": { "enabled": false, "historyDepth": 4 }, 
"reset": { "enabled": false, "forceResetAfterFirstLogin": true, "expiration": { "enabled": true, 
"emailUpon": true, "daysToExpire": 90, "remindPrior": { "enabled": false, "daysBefore": 5, 
"emailUser": true } } } } } }, "links": { "self": 
"/admin/v2/sites/0de7387f-1506-427d-b997-e18bcdb8cbae/passwordSecurity" 
} }

PATCH PowerShell Sample

Copy

### PATCH Account Security Configuration Details ###
### User must obtain the SiteID from Get Sites
Write-Output "PATCH Account Security Configuration Details"
Write-Output "----------------------"
$update = 
'{
  "data": {
    "attributes": {
      "accountPolicy": {
        "invalidLogin": {
          "account": {
            "enabled": true,
            "action": "Disable",
            "attemptPeriodMinutes": 3,
            "attemptRetries": 3,
            "lockoutMinutes": 3
          },
          "ip": {
            "enabled": true,
            "attemptPeriodMinutes": 3,
            "attemptRetries": 3,
            "inCorrectLoginType": "NameOrPassword"
          }
        }
      }
    }
  }
}'
$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 25
$patchReturn = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/accountSecurity" 
-Method 'PATCH' -Headers $authHeader -Body $update