federatedRepository - User Registry Federation (federatedRepository)

Configuration for the user registry federation.

NameTypeDefaultDescription
idstringA unique configuration ID.
maxSearchResultsint4500Maximum number of entries that can be returned in a search.
searchTimeoutA period of time with millisecond precision10mMaximum amount of time, in milliseconds, to process a search. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
pageCacheSizeint1000Defines the number of pagination requests that can be stored in the cache. The paging cache size needs to be configured based on the number of pagination requests executed on the system and the hardware system resources available.
pageCacheTimeoutA period of time with millisecond precision30000msDefines the maximum time that an entry, which added to the page cache, is available. When the specified time has elapsed, the entry from the page cache is cleared. This needs to be configured based on the interval between pagination search requests executed on the system and the hardware system resources available. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.

realm

Reference to the realm.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringName of the realm.
delimiterstring/Delimiter used to qualify the realm under which the operation should be executed. For example, userid=test1/myrealm where / is the delimiter and myrealm is the realm name.
allowOpIfRepoDownbooleanfalseSpecifies whether operation is allowed if a repository is down. The default value is false.

realm > participatingBaseEntry

The Base Entry that is part of this realm.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringName of the base entry.

realm > uniqueUserIdMapping

The input and output property mappings for unique user id used in an user registry operation.

NameTypeDefaultDescription
inputPropertystringuniqueNameThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringuniqueNameThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

realm > userSecurityNameMapping

The input and output property mappings for user security name in an user registry operation.

NameTypeDefaultDescription
inputPropertystringprincipalNameThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringuniqueNameThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

realm > userDisplayNameMapping

The input and output property mappings for user display name in an user registry operation.

NameTypeDefaultDescription
inputPropertystringprincipalNameThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringprincipalNameThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

realm > uniqueGroupIdMapping

The input and output property mappings for unique group id in an user registry operation.

NameTypeDefaultDescription
inputPropertystringcnThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringuniqueNameThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

realm > groupSecurityNameMapping

The input and output property mappings for group security name in an user registry operation.

NameTypeDefaultDescription
inputPropertystringcnThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringcnThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

realm > groupDisplayNameMapping

The input and output property mappings for group display name in an user registry operation.

NameTypeDefaultDescription
inputPropertystringcnThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringcnThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

realm > defaultParents

The default parent mapping for the realm.

NameTypeDefaultDescription
namestringThe name of the entity being mapped. The name of the entity can be PersonAccount or Group.
parentUniqueNamestringThe distinguished name under Base distinguished name (DN) in the repository under which all entities of the configured type will be created.

primaryRealm

Primary realm configuration.

NameTypeDefaultDescription
namestringName of the realm.
delimiterstring/Delimiter used to qualify the realm under which the operation should be executed. For example, userid=test1/myrealm where / is the delimiter and myrealm is the realm name.
allowOpIfRepoDownbooleanfalseSpecifies whether operation is allowed if a repository is down. The default value is false.

primaryRealm > participatingBaseEntry

The Base Entry that is part of this realm.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringName of the base entry.

primaryRealm > uniqueUserIdMapping

The input and output property mappings for unique user id used in an user registry operation.

NameTypeDefaultDescription
inputPropertystringuniqueNameThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringuniqueNameThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

primaryRealm > userSecurityNameMapping

The input and output property mappings for user security name in an user registry operation.

NameTypeDefaultDescription
inputPropertystringprincipalNameThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringuniqueNameThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

primaryRealm > userDisplayNameMapping

The input and output property mappings for user display name in an user registry operation.

NameTypeDefaultDescription
inputPropertystringprincipalNameThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringprincipalNameThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

primaryRealm > uniqueGroupIdMapping

The input and output property mappings for unique group id in an user registry operation.

NameTypeDefaultDescription
inputPropertystringcnThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringuniqueNameThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

primaryRealm > groupSecurityNameMapping

The input and output property mappings for group security name in an user registry operation.

NameTypeDefaultDescription
inputPropertystringcnThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringcnThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

primaryRealm > groupDisplayNameMapping

The input and output property mappings for group display name in an user registry operation.

NameTypeDefaultDescription
inputPropertystringcnThe property that maps to the user registry attribute for input. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.
outputPropertystringcnThe property that maps to the user registry attribute for output. The valid values are: uniqueId, uniqueName, externalId, externalName and the attributes of PersonAccount and Group entity types.

primaryRealm > defaultParents

The default parent mapping for the realm.

NameTypeDefaultDescription
namestringThe name of the entity being mapped. The name of the entity can be PersonAccount or Group.
parentUniqueNamestringThe distinguished name under Base distinguished name (DN) in the repository under which all entities of the configured type will be created.

supportedEntityType

The default parent for an entity type mapping.

NameTypeDefaultDescription
idstringA unique configuration ID.

supportedEntityType > name

The name of the entity being mapped. The name of the entity can be PersonAccount or Group.

supportedEntityType > defaultParent

The distinguished name under Base distinguished name (DN) in the repository under which all entities of the configured type will be created.

extendedProperty

The extended properties for Person and Group.

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringDefines the name of the property extended for Person and Group.
dataType
  • Double
  • Long
  • Date
  • String
  • BigDecimal
  • BigInteger
  • Boolean
  • Integer
Defines the data type of the property extended for Person and Group. The basic Java data types are supported.
Double
Double
Long
Long
Date
Date
String
String
BigDecimal
BigDecimal
BigInteger
BigInteger
Boolean
Boolean
Integer
Integer
entityType
  • PersonAccount
  • Group
The name of the entity being mapped. The name of the entity can be PersonAccount or Group.
PersonAccount
Person
Group
Group
multiValuedbooleanfalseDefines if the property extended for Person and Group supports multiple values.
defaultValuestringDefines the default value for the property during write operation, if no default value is set.