Properties reference

This reference covers agent configuration properties.

When you create the agent profile, you choose whether to store the agent configuration in AM’s configuration store or locally to the agent installation. The local configuration file syntax is the same as of a standard Java properties file.

Property files

The agent stores agent bootstrap and configuration properties in one file, agent.conf.

For IIS Web Agent, the file is located by default at C:\web_agents\iis_agent\instances\agent_1\config\agent.conf

Bootstrap properties

The agent configurations support the following bootstrap properties:

Properties and their functions

The agent configuration properties have the following functions.

Property name

UI title

Function

com.forgerock.agents.accept.ipdp.cookie

Accept SSO token cookie (deprecated)

Profile

com.forgerock.agents.accept.sso.token

Accept SSO Token

Cookies

com.forgerock.agents.advice.b64.url.encode

Composite Advice Encode

Advice handling

com.forgerock.agents.agent.invalid.url.regex

Invalid URL Regular Expression

URL handling

com.forgerock.agents.agent.logout.url.regex

Agent Logout URL Regular Expression

Logout redirect

com.forgerock.agents.cache_control_header.enable

Add Cache-Control Headers

Headers

com.forgerock.agents.call.session.refresh

Reset Idle Timeout

General

com.forgerock.agents.cdsso.cookie.samesite

SameSite Cookie Attribute

Cookies

com.forgerock.agents.conditional.login.url

AM Conditional Login URL

Login redirect

com.forgerock.agents.config.add.amlbcookie

Enable AM Load Balancer Cookie

Load balancing

com.forgerock.agents.config.auth.flow.callback

Authorization flow for applications using Javascript

Login redirect

com.forgerock.agents.config.cert.ca.file

CA Certificate File Name

Encryption

com.forgerock.agents.config.cert.file

Public Client Certificate File Name

Encryption

com.forgerock.agents.config.cert.key

Private Client Certificate File Name

Encryption

com.forgerock.agents.config.cert.key.password

Private Key Password

Encryption

com.forgerock.agents.config.ciphers

Supported Cipher List

Encryption

com.forgerock.agents.config.fallback.mode

Not-Enforced Fallback Mode

Not-enforced

com.forgerock.agents.config.hostmap

Hostname to IP Address Map

General

com.forgerock.agents.config.logout.redirect.disable

Disable Logout Redirection

Logout redirect

com.forgerock.agents.config.max.num.log.files

Maximum Number of Debug Log Files

Logs

com.forgerock.agents.config.plain.channels.insecure

Accept Secure Cookies From AM Over HTTP

Encryption

com.forgerock.agents.config.use.during.update

Use Cached Configuration After Update

Profile

com.forgerock.agents.header.mime.encode

MIME-Encode HTTP Header Values

Headers

com.forgerock.agents.jwt.aud.disable

Disable Audience Claim Validation

Profile

com.forgerock.agents.jwt.aud.whitelist

Agent Profile ID Allow List

Profile

com.forgerock.agents.no.remoteuser.module.compatibility

Use Built-in Apache HTTPD Authentication Directives

Miscellaneous

com.forgerock.agents.notenforced.url.regex.enable

Regular Expressions for Not-Enforced URLs

Not-enforced

com.forgerock.agents.public.am.url

Login URL

com.forgerock.agents.session.cache.eventually.consistent

Retain Session Cache After Configuration Change

Profile

com.sun.am.use_redirect_for_advice

Composite Advice Handling

Advice handling

com.sun.identity.agents.config.access.denied.url

Resources Access Denied URL

General

com.sun.identity.agents.config.agent.logout.url

Logout URL List

Logout redirect

com.sun.identity.agents.config.agenturi.prefix

Agent Deployment URI Prefix

Profile

com.sun.identity.agents.config.anonymous.user.enable

Client identification

com.sun.identity.agents.config.attribute.multi.value.separator

Attribute Multi-Value Separator

Attribute processing

com.sun.identity.agents.config.audit.accesstype

Audit Access Types

Audit

com.sun.identity.agents.config.cdsso.cookie.domain

Cookie Domain List

Cross-domain single sign-on

com.sun.identity.agents.config.cdsso.redirect.uri

CDSSO Redirect URI

Cross-domain single sign-on

com.sun.identity.agents.config.change.notification.enable

Enable Notifications of Agent Configuration Change

Profile

com.sun.identity.agents.config.client.hostname.header

Client Hostname Header

Client identification

com.sun.identity.agents.config.client.ip.header

Client IP Address Header

Client identification

com.sun.identity.agents.config.client.ip.validation.enable

Client IP Validation

Not-enforced

com.sun.identity.agents.config.connect.timeout

Connection Timeout

Miscellaneous

com.sun.identity.agents.config.cookie.name

Cookies

com.sun.identity.agents.config.cookie.reset

Cookie Reset List

Cookies

com.sun.identity.agents.config.cookie.reset.enable

Enable Cookie Reset

Cookies

com.sun.identity.agents.config.cookie.secure

Enable Cookie Security

Cookies

com.sun.identity.agents.config.debug.file.size

Agent Debug File Size

Debug

com.sun.identity.agents.config.debug.level

Agent Debug Level

Debug

com.sun.identity.agents.config.encode.cookie.special.chars.enable

Encode Special Characters in Cookies

Cookies

com.sun.identity.agents.config.encode.url.special.chars.enable

Encode Special Characters in URLs

URL handling

com.sun.identity.agents.config.fetch.from.root.resource

Fetch Policies From The Root Resource

Policy client service

com.sun.identity.agents.config.forward.proxy.host

Proxy Server Host Name

Forward proxy

com.sun.identity.agents.config.forward.proxy.password

Proxy Server Password

Forward proxy

com.sun.identity.agents.config.forward.proxy.port

Proxy Server Port

Forward proxy

com.sun.identity.agents.config.forward.proxy.user

Proxy Server User

Forward proxy

com.sun.identity.agents.config.fqdn.check.enable

Enable FQDN Check

FQDN check

com.sun.identity.agents.config.fqdn.default

FQDN check

com.sun.identity.agents.config.fqdn.mapping

FQDN Virtual Host Map

FQDN check

com.sun.identity.agents.config.freeformproperties

Custom Properties

Custom

com.sun.identity.agents.config.get.client.host.name

Enable Retrieve Client Hostname

Policy client service

com.sun.identity.agents.config.ignore.path.info

Ignore Path Info in Request URLs

Ignore path info

com.sun.identity.agents.config.ignore.path.info.for.not.enforced.list

Ignore Path Info in Not-Enforced URLs

Not-enforced

com.sun.identity.agents.config.iis.logonuser

Logon and Impersonation

Microsoft IIS server

com.sun.identity.agents.config.iis.password.header

Show Password in HTTP Header

Microsoft IIS server

com.sun.identity.agents.config.key

Agent Profile Password Encryption Key

Agent profile

com.sun.identity.agents.config.key.cache.disable

Disable Caching of Agent Profile Password Encryption Key

Encryption

com.sun.identity.agents.config.local.audit.logfile

Local Agent Audit File Name

Audit

com.sun.identity.agents.config.local.log.size

Local Audit Log Rotation Size

Logs

com.sun.identity.agents.config.local.logfile

Local Agent Debug File Name

Logs

com.sun.identity.agents.config.log.disposition

Audit Log Location

Audit

com.sun.identity.agents.config.login.url

Login redirect

com.sun.identity.agents.config.logout.cookie.reset

Reset Cookies on Logout List

Logout redirect

com.sun.identity.agents.config.logout.redirect.url

Logout Redirect URL

Logout redirect

com.sun.identity.agents.config.logout.url

Logout redirect

com.sun.identity.agents.config.naming.url

AM Connection URL

Miscellaneous

com.sun.identity.agents.config.notenforced.ip

Not-Enforced IP List

Not-enforced

com.sun.identity.agents.config.notenforced.url

Not-Enforced URL List

Not-enforced

com.sun.identity.agents.config.notenforced.url.attributes.enable

Fetch Attributes for Not-Enforced URLs

Not-enforced

com.sun.identity.agents.config.notenforced.url.invert

Invert Not-Enforced URLs

Not-enforced

com.sun.identity.agents.config.notification.enable

Enable Notifications

Profile

com.sun.identity.agents.config.organization.name

Agent Profile Realm

Agent profile

com.sun.identity.agents.config.override.host

Enable Override Request URL Host

Load balancing

com.sun.identity.agents.config.override.port

Enable Override Request URL Port

Load balancing

com.sun.identity.agents.config.override.protocol

Enable Override Request URL Protocol

Load balancing

com.sun.identity.agents.config.password

Agent Profile Password

Agent profile

com.sun.identity.agents.config.policy.cache.polling.interval

Policy Cache Polling Period

Policy client service

com.sun.identity.agents.config.policy.clock.skew

Policy Clock Skew

Policy client service

com.sun.identity.agents.config.polling.interval

Configuration Reload Interval

Profile

com.sun.identity.agents.config.postcache.entry.lifetime

POST Data Entries Cache Period

POST data preservation

com.sun.identity.agents.config.postdata.preserve.enable

Enable POST Data Preservation

POST data preservation

com.sun.identity.agents.config.postdata.preserve.stickysession.mode

POST Data Sticky Load Balancing Mode

Load balancing

com.sun.identity.agents.config.postdata.preserve.stickysession.value

POST Data Sticky Load Balancing Value

Load balancing

com.sun.identity.agents.config.profile.attribute.cookie.maxage

Profile Attributes Cookie Maxage

Cookies

com.sun.identity.agents.config.profile.attribute.cookie.prefix

Profile Attribute Cookie Prefix

Cookies

com.sun.identity.agents.config.profile.attribute.fetch.mode

Profile Attribute Fetch Mode

Attribute processing

com.sun.identity.agents.config.profile.attribute.mapping

Profile Attribute Map

Attribute processing

com.sun.identity.agents.config.receive.timeout

TCP Receive Timeout

Miscellaneous

com.sun.identity.agents.config.redirect.param

Goto Parameter Name

Goto parameter

com.sun.identity.agents.config.replaypasswd.key

Replay Password Key

Microsoft IIS server

com.sun.identity.agents.config.repository.location

Location of Agent Configuration Repository

Profile

com.sun.identity.agents.config.response.attribute.fetch.mode

Response Attribute Fetch Mode

Attribute processing

com.sun.identity.agents.config.response.attribute.mapping

Response Attribute Map

Attribute processing

com.sun.identity.agents.config.session.attribute.fetch.mode

Session Attribute Fetch Mode

Attribute processing

com.sun.identity.agents.config.session.attribute.mapping

Session Attribute Map

Attribute processing

com.sun.identity.agents.config.sso.cache.polling.interval

SSO Cache Polling Period

Policy client service

com.sun.identity.agents.config.sso.only

Enable SSO Only Mode

General

com.sun.identity.agents.config.trust.server.certs

Server Certificate Trust

Encryption

com.sun.identity.agents.config.url.comparison.case.ignore

Enable URL Comparison Case Sensitivity Check

URL handling

com.sun.identity.agents.config.userid.param

User ID Parameter

Policy client service

com.sun.identity.agents.config.userid.param.type

User ID Parameter Type

Policy client service

com.sun.identity.agents.config.username

Agent Profile Name

Agent profile

com.sun.identity.cookie.httponly

Enable HTTP Only Mode

Cookies

Profile

Profile

org.forgerock.agents.config.cdsso.advice.cleanup.disable

Enable Session Cookie Reset After Authentication Redirect

Cross-domain single sign-on

org.forgerock.agents.config.cdsso.persistent.cookie.enable

Persist JWT Cookie

Cookies

org.forgerock.agents.config.cert.verify.depth

OpenSSL Certificate Verification Depth

Encryption

org.forgerock.agents.config.conditional.login.pattern

Regular Expression Conditional Login Pattern

Login redirect

org.forgerock.agents.config.conditional.login.url

Regular Expression Conditional Login URL

Login redirect

org.forgerock.agents.config.connection.pool.enable

Enable Connection Pooling

Connection pooling

org.forgerock.agents.config.fragment.redirect.enable

Enable Fragment Redirect

Fragment redirect

org.forgerock.agents.config.iis.headers.server.disable

Remove IIS HTTP Server Header

Microsoft IIS server

org.forgerock.agents.config.json.header

Headers and Values to Receive JSON-Formatted Responses

JSON-formatted response

org.forgerock.agents.config.json.response.code

HTTP Return Code for JSON-Formatted Responses

JSON-formatted response

org.forgerock.agents.config.json.url

List of URLs to Receive JSON-Formatted Responses

JSON-formatted response

org.forgerock.agents.config.json.url.invert

Invert Properties That Receive JSON-Formatted Responses

JSON-formatted response

org.forgerock.agents.config.logout.regex.enable

Enable Regex for Logout URL List

Logout redirect

org.forgerock.agents.config.logout.session.invalidate

Enable Invalidate Logout Session

Logout redirect

org.forgerock.agents.config.notenforced.ext.regex.enable

Enable Regular Expressions for Not-Enforced IPs

Not-enforced

org.forgerock.agents.config.notenforced.ipurl

Not-Enforced URL from IP Processing List

Not-enforced

org.forgerock.agents.config.postdata.preserve.dir

POST Data Storage Directory

POST data preservation

org.forgerock.agents.config.secure.channel.disable

Enable OpenSSL to Secure Internal Communications

Encryption

org.forgerock.agents.config.skip.post.url

URLs Ignored by the POST Data Inspector

POST data preservation

org.forgerock.agents.config.tls

Security Protocol List

Miscellaneous

org.forgerock.agents.pdp.javascript.repost

Submit POST Data using JavaScript

POST data preservation

org.forgerock.openam.agents.config.allow.custom.login

Enable Custom Login Mode

Login redirect

org.forgerock.openam.agents.config.balance.websocket.connection.interval.in.minutes

Web Socket Connection Interval

Profile

org.forgerock.openam.agents.config.continuous.security.cookies

Continuous Security Cookie Map

Continuous Security

org.forgerock.openam.agents.config.continuous.security.headers

Continuous Security Header Map

Continuous Security

org.forgerock.openam.agents.config.jwt.name

JWT Cookie Name

Profile

org.forgerock.openam.agents.config.multivalue.pre.authn.cookies

Enable Multivalue for Pre-Authn Cookie

Cookies

org.forgerock.openam.agents.config.policy.evaluation.application

Policy client service

org.forgerock.openam.agents.config.policy.evaluation.realm

Policy Evaluation Realm

Policy client service

Profile

sunIdentityServerDeviceKeyValue

Agent Root URL for CDSSO

Profile