Enable Custom Login Mode

Allow Custom Login Mode

Set the login redirection mode, as follows:

  • false: Use the default login redirection mode. This mode uses OpenID Connect ID tokens (JWTs) for authentication. Use with OAuth Login URL List to modify or redirect calls to the endpoint which provides the tokens.

  • true: Use the custom login redirection mode, for more control on where the agent redirects the user for authentication. Use with AM Login URL List and Legacy Login URL List to modify or redirect calls to modify or redirect calls.

During session upgrade the format of the composite advice is as follows:

  • When both this property and Enable SSO Token Acceptance are true, the composite advice has the following format: ?authIndexType=composite_advice&authIndexValue=<Advices Value>

  • When either property is false, the composite advice has the following format: ?composite_advice=<Advices Value>

Property name

org.forgerock.agents.legacy.login.enabled

Property aliases

org.forgerock.agents.legacy.login.enabled (since 5.6)

org.forgerock.openam.agents.config.allow.custom.login (since 5.6)

Type

Boolean: true returns true; all other strings return false.

Default

false

Bootstrap property

No

Required property

No

Restart required

No

Local configuration file

AgentConfig.properties

AM console tab

AM Services