Java Agents 2024.11

AM Login URL List

The URL of the login page to use for authentication.

During the redirect, the agent appends the following parameters to the agent’s CDSSO endpoint:

Use the format URL[?realm=realm_name?parameter1=value1&…​], where:

  • URL: URL of the login page to use for authentication

  • [?realm=realm_name&parameter1=value1&…​]: Optional parameters that the agent passes to the login page, for example, the AM realm at which to authenticate.

You do not need to specify an authentication realm if any of the following conditions are true:

  • The custom login page sets the realm parameter, for example, because it lets the user choose the realm.

  • The user authenticates into a realm that has DNS aliases configured in AM. AM then logs the user into the realm whose DNS alias matches the incoming request URL. For example, an inbound request from http://marketplace.example.com logs in the marketplace realm if the realm alias is set to marketplace.example.com.

  • The user authenticates to the top-level realm.

This parameter can be overwritten by the custom login page if, for example, the user chooses the authentication realm.

Specify as many parameters your custom login pages require.

Example:

https://login.example.com/login.jsp?realm=marketplace&param1=value1

In some versions of AM you can configure more than one value for this property, but only the first value is honored.

Property name

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

Aliases

com.sun.identity.agents.config.login.url
  Introduced in Java Agent 5.0
  Recognized from AM 6

Function

Custom login redirect, Default Login Redirect, Login redirect, Login Redirect (Default)

Type

List

Bootstrap property

No

Required property

No

Restart required

No

Local configuration file

AgentConfig.properties

AM console

Tab: AM Services

Title: AM Login URL List

Legacy title: AM Login URL

Copyright © 2010-2024 ForgeRock, all rights reserved.