Cluster

Cluster singleton configuration allows to view and modify the settings of the DirX Access cluster entry that represents the cluster of all the DirX Access Services servers that are defined in one Application Repository. All configured properties are shared by all Services servers. The DirX Access installation program creates the DirX Access cluster entry automatically with default settings. You must modify these settings with values that match your environment.

Description

Description of the configuration object

Application repository service

The holder for Application Repository service settings.

Do enable Application Repository cache

Whether or not the Application Repository cache is enabled or disabled.

Application Repository cache expiration time

The expiration time in seconds of the cached records.

Application Repository cache size

The max size of the cache.

Do enable Application Repository cache refresh

Whether or not the refresh of the records according the change log service is enabled or disabled including event messaging.

Application Repository cache refresh time

The refresh time in seconds to refresh cached records according the change log service.

Enable application-repository groups

Whether or not group membership is determined from the groups stored in application-repository. These groups can be managed trough the SCIM 2.0 API.

Use 'member of' attribute optimization (application-repository groups)

Whether or not the 'memberOf' attribute is used to determine group membership for groups application repository. If you are using DirX directory, you must set the initial index for the member attribute in DirX directory (Schema -> Database) and configure Prescriptive ACI to allow reading the dirxMemberOf attribute (Configuration -> Root -> app repository Administrative point -> Access Control Subentries.). The membership might also contain nested and dynamic groups. For DirX directory the 'dirxMemberOf' attribute is used, for AD 'memberOf' is used. In DirX directory this will result in faster search for recursive group membership.

Enable application-repository roles

Whether or not roles are determined from the application repository.

Resolve group membership recursively (application-repository groups)

Whether or not nested groups are resolved for the groups resolved from application repository. If enabled it will be possible to add groups as members trough SCIM and membership in nested groups will be resolved for the users. Note that when DirX directory is used as application repository, the groups must have at least one member (according to DirX directory documentation), so it can be resolved as parent group. If you want to force not resolving nested groups, you should also disable usage of the 'memberOf' attribute.

Resolve group roles (application-repository groups)

Whether or not roles for the user are resolved from the groups saved in the application repository. If enabled it will be possible to add roles to groups trough SCIM and roles will be resolved for the users from the groups. Determining of roles from application repository must also be enabled.

Group format (application-repository groups)

The format of the group name that will be used in request injections for groups resolved for the Application Repository. If empty, the FQN of the group will be returned. The format can contain placeholders for the group name (CN) (#1) and a domain (#2). The placeholders are replaced with the actual values when the group is added to a request injection.

Group domain (application-repository groups)

The domain that will be used in request injections for groups resolved for the Application Repository. The 'Group name format (application-repository groups)' must not be empty in order for the domain name to be used.

Do enable modification operations during Shadow User Tree startup import.

Whether modification operations are allowed during import from startup folder during DirX Access Server startup. If enabled, entries can be modified during import. If not enabled, already existing entries are moved to a partial file that can be reviewed manually and imported in next DirX Access Server startup.

Audit service

The holder for Audit service settings.

Level of audit for authentication service

The audit level for the authentication service.

  • Allowed Values:

    • info

    • warning

    • error

    • none

Level of audit for authorization service

The audit level for the actual decision making of the authorization service. Enabling auditing for the authorization service typically leads to the production of an extensive amount of audit messages. Make sure you carefully consider the value of this setting.

  • Allowed Values:

    • info

    • warning

    • error

    • none

Audit callout handler identifier

The identifier for the callout handler that is responsible for auditing events (default: Log4JAuditCalloutHandler).

Emergency strategy

The emergency strategy for the auditing source. Auditing sinks are required to be able to handle the number of audit events produced. The emergency strategy addresses the case when the auditing sink cannot satisfy this requirement. The currently recognized values are DROP, THROTTLE and NONE. With the drop strategy, the loss of audit events is permitted but performance is not degraded. With the throttle strategy, performance degradation is permitted but audit events cannot be lost. With the none strategy will drop events without emitting any warning to the log file.

  • Allowed Values:

    • NONE

    • DROP

    • THROTTLE

Level of audit for federation service

The audit level for the federation service.

  • Allowed Values:

    • info

    • warning

    • error

    • none

Audit nested authorization decisions

Whether or not lower-level authorization decisions are audited. This setting is applicable to authorization decisions made by secondary PDPs (typically, Role-Enablement Authorities). Unchecking this option may decrease the volume of audit data.

Maximum audit queue size

The maximum queue size for the auditing service. A value of 0 specifies an unlimited audit queue size.

Custom audit contents template identifiers

The identifiers for request injection templates to be used to customize audit event contents. Use this field to assign request injection template configuration objects to the DirX Audit service that instruct the service on how to provide customized information in audit event objects. This extension to the DirX Access audit service also requires auditing sinks that implement a consumer that uses the AuditEvent Java class Map<String, String[]> getCustomProperties().

Level of audit for server lifecycle

The audit level for the server lifecycle.

  • Allowed Values:

    • info

    • warning

    • error

    • none

Level of audit for SSO service

The audit level for the SSO service.

  • Allowed Values:

    • info

    • warning

    • error

    • none

Level of audit for Application Repository service

The audit level for the Application Repository service.

  • Allowed Values:

    • info

    • warning

    • error

    • none

Number of audit threads

The number of threads assigned to servicing the auditing queue. Increasing this value can increase auditing service performance but will use more system resources.

Level of audit for user service

The audit level for the user service.

  • Allowed Values:

    • info

    • warning

    • error

    • none

Authentication service

The holder for Authentication service settings.

Authentication Authority

The identifier of the authentication authority returned in the SSO_SERVICE -> AUTHENTICATION_INFO -> AUTHENTICATION_AUTHORITY request injection value and as an issuer of the FEDERATION_SERVICE -> ISSUED_SAML_ASSERTION SAML assertion.

Attribute finder callout handler identifier

The identifier of the callout handler for the attribute finder plug-in.

Authentication token finder callout handler identifier

The identifier of the callout handler for the authentication token finder plug-in.

Name mapping callout handler identifier

The identifier of the callout handler for the name mapping plug-in.

Do store domain names

Whether or not the domain names are persisted in the Application Repository, enabling an inter-session user-specific data merging. For more information, see the section 'Name Resolution' in the appendix 'Advanced Topics'.

Enable anonymous subject

Whether or not to enable anonymous subject to be the result of the authentication process.

Whether or not it is required to have a user consent with collecting user data when storing RBA related data.

Cache service

The holder for Cache service settings.

Number of backups

A non-negative value that determines the number of backups performed for caches that do not completely replicate their state on all of the services servers in the cluster (partitioned caches).

Use SSL/TLS

Whether or not the shared cache communication is protected by SSL/TLS.

Keystore identifier

The identifier of the crypto container to be used to establish SSL context (for 'KeyManagerFactory') in case the shared cache communication is protected by SSL/TLS.

Truststore identifier

The identifier of the crypto container to be used to establish SSL context (for 'TrustManagerFactory') in case the shared cache communication is protected by SSL/TLS. The keystore is tried to be used instead in case truststore is not set.

Do static cluster resolution

Whether or not the static cluster resolution mechanism shall be used.

Cache servers

Map of cache servers consistent identifiers (address : port) as keys and the data centers given server resides as values.

Do cross data center backup

If true, the algorithm guarantees to assign at least one backup copy (if configured) to a cache server residing in different data center than the primary created record (the primary record is stored in the cache server that is primary to the DXA server creating the record).

Communication service

The holder for communication settings.

Cluster hostname

The host name of the cluster. Please note that the maximum supported hostname length is 128 ASCII characters. The value must be without scheme and port.

Crypto service

The holder for Crypto service settings.

Do enable cache

The decision whether or not the Crypto cache is enabled or disabled.

Cache expiration time

The expiration time in seconds of the cached records.

Cache size

The max size of the cache.

CRL callout handler identifier

The identifier of the callout handler handling CRL finder events.

Federation service

The holder for Federation service settings.

Do update user account

Whether or not the persistent SAML NameID is supported (applicable to SAML IdPs).

Session stored SAML assertion limit

The maximum number of SAML assertions stored for session (-1 means no limit).

SSO service

The holder for SSO service settings.

SSO cache mode

The operating mode of the SSO cache. Possible values are:

  • PARTITIONED: In this mode, the cache data are equally distributed across all the DirX Access Services servers, providing better performance. The data loss is solved according to the 'Cache number of backups' field. This is the default SSO cache mode.

  • REPLICATED: In this mode, all the cache data are replicated on all the DirX Access Services servers.

  • LOCAL: In this mode, the SSO data remain on the server of their origin.

  • Allowed Values:

    • REPLICATED

    • PARTITIONED

    • LOCAL

SSO callout handler identifiers

The identifiers of the callout handlers handling SSO events.

Do SSO session correlation

Whether or not SSO session correlation is performed.

SSO maximum number of subjects

The maximum number of authenticated subject representations the SSO service can maintain.

SSO subject identifier length

The length (in bytes) of the (random) identifiers to SSO session objects.

SSO refresh subject after seconds

The interval (in seconds) at which subject refresh is performed. A value greater than zero defines the number of seconds after a refresh at which the subject is refreshed again. A value of 0 means that the subject is refreshed regardless of the time elapsed since the last refresh. A negative value means that subject refresh is not performed.

SSO update subject after seconds

The interval (in seconds) between two consecutive SSO requests during which the subject’s internal state (for example, last access time) is not updated. A value greater than zero defines the number of seconds after an update at which the subject is updated again. A value of 0 means that the subject is updated regardless of the time elapsed since the last update. A negative value means that subject update is not performed. An appropriate value (for example, 1 second) improves cache performance (by decreasing the number of synchronization messages).

SSO validation interval

The interval (in seconds) at which to check the timeout or idle timeout of SSO session objects.

Do use JWT token

If true, the JWT token will be used for representation of the session identifier. Otherwise, the random string representation will be used.

Crypto container identifiers

References to cryptographic material containers.

User service

The holder for User service settings.

Maximum number of returned users

The maximum number of entries returned when performing user searches. Note that you cannot exceed a possible server-side size limit.

Do enable user cache

Whether or not the user cache is enabled or disabled.

User cache expiration time

The expiration time in seconds of the cached records.

User cache size

The max size of the cache.

LDAP query optimization

Whether or not the LDAP query optimization is enabled or disabled. Only configured LDAP attributes are requested from the user repository. These LDAP attributes are derived from the current DirX Access configuration.