Configuring the Remedy SSO agent
As a Remedy Single Sign-On administrator, you can configure the Remedy SSO agent by setting up properties in the rsso-agent.properties file. By modifying this file, you set up integration of the Remedy SSO server with other BMC applications.
Tip
To apply changes to the Remedy SSO agent configuration, ensure that updated properties in the rsso-agent.properties file are not commented. Else, the default values are used.
General properties
The following table lists general properties that you modify for the Remedy SSO agent. For example, if you have Remedy SSO and an integrated BMC application deployed on different domains, you must set the multi-domain-support
property to true.
Parameter | Description |
---|---|
agent-id | Identifies a BMC application integrated with Remedy SSO. You can specify any text value or an application URL for this property. If you have Remedy SSO deployed in high-availability mode, you must specify the same value as Example
|
skip-filter | Disables the Remedy SSO agent if the parameter is set to true. In this case, requests are not processed by Remedy SSO. Example
Note: If RSSOAuthenticator in Mid Tier is used, perform the following steps to disable the Remedy SSO agent:
|
multi-domain-support | If you have Remedy SSO and an integrated BMC application deployed on different domains, you must configure the Remedy SSO agent to support this deployment use case. For more information about this use case, see Deployment scenarios. Set the Example
|
token-timeout-synchronization | Note: This property is applicable only when multi-domain support is enabled. If this property is set to true, the time difference between the Remedy SSO agent and the Remedy SSO server is ignored. This property, set in seconds, specifies the time offset between the Remedy SSO server and the Remedy SSO agent. For example, if the Remedy SSO agent receives a token from the Remedy SSO server, and the token issue time according to the time set on the Remedy SSO agent is future, the Remedy SSO agent accepts the token without any errors. By default, Example
|
preauth-type | Enables the Remedy SSO agent to expect JSON Web Token (JWT) in the authentication flow. Depending on how the integrated BMC application sends a JWT to Remedy SSO, configure the Remedy SSO agent to expect JWT by HTTP Example
For more information about the preauthentication authentication type, see Preauthentication. |
action-path-mask | Enables end users to change their passwords by accessing the Action Request System server from Remedy SSO. The following setting is enabled by default in the rsso-agent.properties configuration file:
For more information about how to use this option, see Configuring the Remedy SSO agent to enable end users to change their passwords. |
msp-deployment | If this property is set to true, the realm entry page for Multi-Service Provider (MSP) deployments is displayed to end users in cases where the Remedy SSO server cannot identify to which realm an end user belongs. To always display the realm entry page for MSP deployments, set the
|
Properties related to URLs
The following table lists properties that enable you to modify URLs. For example, you can define an external URL to which a user who attempts to log in to an integrated BMC application is redirected. This is done by setting up the sso-external-url
property.
sso-external-url | Defines a server user-facing (external) URL of the Remedy SSO server. The external URL can be the same or different from the internal URL, but both of these URLs must point to the same server where Remedy SSO is deployed. The external URL is the user-facing RSSO Server URL which may actually be the LB or ingress controller behind which the actual RSSO Server is deployed. This URL must be accessible by the end users The Remedy SSO agent redirects the browser (user’s request) to
To support multiple Remedy SSO web applications, set the value to a comma separated string: each represents an 'application FQDN' mapping, with the format of <application FQDN>:<url>. Example
|
sso-service-url | Defines a service (internal) URL of the Remedy SSO server. Internal service calls are server-to-server. The Remedy SSO agent uses the
Example
Important: When you configure support of multiple Remedy SSO web applications, set the value to a comma separated string, each representing a domain to the server URL mapping, with the <application FQDN>:<server url> format.
For more details about this use case, see Connecting the same Remedy SSO agent to different Remedy SSO servers. |
logout-urls | Identifies a BMC application URL that triggers Remedy SSO logout. If the logout link generated by the BMC application matches the Example
|
excluded-url-pattern | Defines which URLs must not go through the Remedy SSO web agent filter. By default, the following configuration is applied:
|
context-included | Provides a means to enable or disable the option to check the application context by the Remedy SSO agent filter. To include the application context in
|
callback-url | Identifies a URL to which a user must be redirected after Remedy SSO completes a logout flow. Remedy SSO redirects an end user only to the same domain as the application domain after the completion of the logout process. For example, if the application domain is bmc.com, any combination of <URL>.bmc.com is allowed. Example
Alternatively, you can add the
If you combine If you do not specify both If you specify After logout URL for a realm in the Remedy SSO Admin Console, end users are redirected to the specified URL page. For more information about After logout URL, see Configuring general settings for a realm. |
redirect-mode | The Remedy SSO agent answers 401 Unauthorized with hidden By default, the value of this property is false and the Remedy SSO agent answers 401 Unauthorized. If this value is true, the Remedy SSO agent switches back to the old-style 302 Redirect behavior.
Note: If the multi-domain support is enabled, the Remedy SSO agent answers 302 Redirect irrespective of the |
Properties related to sessions
The following table lists properties that enable you to modify session configuration for the integration of Remedy SSO and a BMC application. For example, you can select a mode in which token data is stored. To perform this action, set the use-in-memory-cache
property.
Parameter | Description |
---|---|
token-status-cache-timeout | Defines the time during which the cached session token remains valid without verification by the Remedy SSO server. Time is indicated in seconds. Example
|
use-in-memory-cache | Enables you to choose between an HTTP session and in-memory cache to store the token data. Note: After you enable the in-memory cache, restart the BMC application integrated with Remedy SSO. Examples
|
Comments
Log in or register to comment.