Agent Security API

Use the Agent Security API to get and update the status of global switch for generating advanced agent password hashing, and also to clear older agent password hashes from the system.

This API is available for administrators only, applicable for all the deployments, and is not supported in SSO modes.

URL

https://unifiedconfig/config/agentsecurity

Operations

  • get: Returns the secure global switch value.

    https://unifiedconfig/config/agentsecurity?details=true

  • update: Updates the secure global switch status and clears the older agent password from the system.

Parameters

enforceAdvancedHashing: true means, global switch will be enabled and removes older Agent passwords, false means global switch will be disabled.

Example Get Response

Code Snippet
Copy<agentSecurity>
     <enforceAdvancedHashing>true</enforceAdvancedHashing>
    <agentsWithoutAdvancedHashing>10</agentsWithoutAdvancedHashing>
    <unsupportedPeripheralGateways>2</unsupportedPeripheralGateways>
</agentSecurity>

Example Update Request

Code Snippet
Copy
<agentSecurity>
    <changeStamp>277</changeStamp>
    <enforceAdvancedHashing>true</enforceAdvancedHashing>
</agentSecurity>