Access Federation Parameters

entity-types-to-sync

Specifies which entities should be synchronized to the target servers configured. Possible values are:

- users

- groups

- permissions

- tokens

exclude-users

Optional

Specific users that should be excluded from synchronization

buffer-wait-millis

Optional [Default: 30000]

The time (ms) between synchronization attempts.

For example: buffer-wait-millis = 3000 means that every 30 seconds the source Access service will attempt to sync with the target Access service.

buffer-max-size

Optional [Default: 500]

The maximum number of entities that can be accumulated between synchronization attempts.

For Example: buffer-max-size = 500 means that whenever 500 security entity updates have been accumulated, the source Access service will attempt to sync with the target Access.

consider-stale-hours

Optional [Default: 168 (one week)]

The length of time a receiving server can fail to respond or respond with an error before it is considered to be "stale" and unable to be synchronized with updates. Once a server is deemed to be "stale", it can only be brought back into operation using the REST API endpoint described in Updating a Stale Server.

maximum-future-time-diff-millis

Optional [Default: 60000

If an Access service is updated, and another update is subsequently synchronized over to it, the Access service will only accept the subsequent change if its timestamp is at least maximum-future-time-diff-millis later than the previous update.

For more details, please refer to Handling Synchronization Conflicts.

timeout-millis

Optional [Default: 3000]

The length of time after synchronizing an update that an Access service will wait for acknowledgment from the receiving Access service before retrying to synchronize the update. If no acknowledgment is received within this period of time, the sending server will retry synchronizing the update to the target server the number of times specified in the number-of-retries parameter.

number-of-retries

Optional [Default: 3]

The number of times an Access service will attempt to synchronize an update to a distant service until. If an acknowledgment is not received from the target server after this number of retries the synchronization is deemed to have failed.

max-stored-events

Optional [Default: -1]

The threshold number of events stored in the database.

By default, the value is -1, which means that unlimited number of events are stored

auto-full-sync-recovered-servers

Optional [Default: false]

Whether to automatically fully synchronize stale services.

servers

The logical name and URL of target Access services to which this Access service can synchronize entities

service-id-mapping

When a service such as Mission Control, Xray, or Distribution selects an Artifactory instance as its authentication provider, that service's service ID is automatically registered with the corresponding Access service.

This field maps the service IDs of services being synchronized over to this Access service. The mapping is automatically generated by Access and need not be entered manually except for a few limitations described below.

For a synchronization target, the "from" and "to" fields define the mapping of service IDs.

The from: field should specify the service type with a wildcard character. For example, for Artifactory, specify jfrt@*, f or Xray, specify jfxr@*.

The to: field should specify the specific service to which the source service (in the from: field) is being mapped.

allow-partial-entity-sync

Optional [Default: false]

Whether to allow advanced conflict resolution to merge and resolve conflicted entities.

permission-filter

Optional

You can select to filter permissions with an include-pattern or exclude-pattern filter that filters federated permissions per server.