AD Agent Function Definitions Skip to main content
https://support.okta.com/help/oktaarticledetailpage?childcateg=&id=ka02a0000005ua3sai&source=documentation&refurl=http%3a%2f%2fsupport.okta.com%2fhelp%2fdocumentation%2fknowledge_article%2fad-agent-function-definitions-1988309940
How satisfied are you with the Okta Help Center?
Thank you for your feedback!
How satisfied are you with the Okta Help Center?
1
2
3
4
5
Very Dissatisfied
Very satisfied
Enter content less than 200 characters.
AD Agent Function Definitions
Published: Sep 14, 2017   -   Updated: Jun 22, 2018

 

 

okta-doc-source

AD Agent Function Definitions

This article details the appSettings listed in the Active Directory (AD) agent configuration file:
C:\Program Files (x86)\Okta\Okta AD Agent\OktaAgentService.exe.config

Warning: This information is provided for reference only. Except in rare cases (for example, to alter the number of threads the AD agent uses to poll the server for tasks), Admins should not modify these settings.

  • BaseOktaURI - URL for the org.
  • AgentToken - Encrypted value for the API token that the agent uses for calling Okta.
  • AgentId - Unique identifier for the agent, generated during installation.
  • AgentName - Human readable ID for the agent. By default, this is the hostname of the domain controller on which the agent is installed. Changes to the value are reflected in the Okta AD Agent Manager but not in Okta.
  • AppId - Unique identifier for the directory to which this agent belongs. The AppId forms part of the URL when you are on the directory integrations page for this instance. For example:

    https://acme.okta.com/admin/app/active_directory/instance/0oa5c6b3zzMBmPCoH0h7

  • ProxyURL - The url:port for the proxy used by this agent, if any. If no value is given for this setting, then a proxy is not being used. Likewise, if there is a value that cannot be resolved as a valid URL, no value is given for this setting.
  • ProxyUsername - If the proxy requires authentication, the username is used. By default, no value is given for this setting(none required).
  • ProxyPassword - If the proxy requires authentication, the encrypted value for the password is used. By default, no value is given for this setting(none required).
  • PollingThreads - The number of concurrent polling requests (between 1 and 10) running between the agent and Okta. A number outside this range sets the number of threads at the minimum or maximum (whichever boundary is exceeded). The default value is 2.
  • VerboseLogging - The value is either True or False. True ensures that the log contains more information (mostly in the user provisioning flow). The default value is False.
  • ConnectionLimit - The value for system.net.servicepointmanager.defaultconnectionlimit. The default .NET limit of two concurrent connections is maintained if Okta fails to parse the value of this setting. For more information, see here.
  • MaxRetryLimitSleep - Related to circumstances when an agent is unable to reach Okta. The intervals during which disconnected agents are not polling Okta become progressively longer. When the agent is reconnected, polling resumes at the normal frequency. This setting specifies the duration of non-polling ("sleep") intervals. By default, this setting is set to the maximum setting of 1 hour in milliseconds (3600000).
  • SslPinningEnabled - When SSL pinning is enabled, the AD agent confirms that the SSL certificate presented by the Okta org matches one of the keys hard-coded in the agent. The default is True.
Top