Differences

This shows you the differences between two versions of the page.

--- 72:ldap_optional_attributes [2018/11/08 09:14] – [Optional Attributes] etea
+++ 72:ldap_optional_attributes [2024/02/15 00:00] (current) – external edit 127.0.0.1
@@ Line 34: / Line 34: @@
 The referrals attribute can be used to configure the handling of LDAP referrals. Possible behavior and values are “follow“ or “ignore“. By default, Stages will follow referrals.
+=== The ignorePartialResultExeption Attribute ===
+When enabled, this attribute causes the PartialResultException to be ignored if the referrals attribute is set to "ignore".\\
+The ignorePartialResultException attribute is configured on the ldap-provider.
 === The searchFilter Attribute ===
@@ Line 45: / Line 50: @@
 |(sn=sm*)|All entries with a surname that starts with "sm"| | |
 |(&(sn=smith)(objectClass=user)(email=*))|All entries that are users having the surname "smith" and an email address.| | |
-|(&(objectClass=user)(!age<18)<font inherit/Arial,Helvetica,sans-serif;;inherit;;inherit>(</font>|(sn=smith)(sn=wright)))|All entries that are users having surname set to "smith" or "wright" and are older than 18| |
+|(&(objectClass=user)(!age<18)
+ ( |(sn=smith)(sn=wright)))|All entries that are users having surname set to "smith" or "wright" and are older than 18| |
-**NOTE**: In the <font inherit/Courier New,Courier,monospace;;inherit;;inherit>Config.xml</font> file the character “&“ has to be escaped via “&“. Otherwise errors parsing the configuration file could occur.
+**NOTE**: In the
+ Config.xml  file the character “&“ has to be escaped via “&“. Otherwise errors parsing the configuration file could occur.
-There is a special memberOf keyword available on many LDAP directory servers. In the case of Microsoft Active Directory, groups are represented via entries of object class “group“ by default. The distinguished names of the group members are set in the member attributes of the group entry. On the other hand, the distinguished name of every group a user is part of is automatically set in a <font inherit/Courier New,Courier,monospace;;inherit;;inherit>memberOf</font>attribute of the user entry.
+There is a special memberOf keyword available on many LDAP directory servers. In the case of Microsoft Active Directory, groups are represented via entries of object class “group“ by default. The distinguished names of the group members are set in the member attributes of the group entry. On the other hand, the distinguished name of every group a user is part of is automatically set in a
+ memberOf  attribute of the user entry.
 The following search filter example shows how to filter users according to a certain group membership using the memberOf attribute:
-''<font inherit/Courier New,Courier,monospace;;inherit;;inherit>searchFilter="(memberOf=CN=SampleGroup,DC=pkit,DC=methodpark,DC=de)“</font>''
+'' searchFilter="(memberOf=CN=SampleGroup,DC=pkit,DC=methodpark,DC=de)“  ''
 If the memberOf attribute is not available on your LDAP directory server, it is possible to retrieve the members of a certain group by querying the member attribute of a group entry.
-The following search filter example shows how to query the users of a group without using the <font inherit/Courier New,Courier,monospace;;inherit;;inherit>memberOf</font>attribute:
+The following search filter example shows how to query the users of a group without using the
+ memberOf  attribute:
+'' searchFilter="distinguishedName=CN=SomeGroup,DC=er,DC=methodpark,DC=de"  ''
+The filter specifies that the distinguished name of the (group) entry has to be
+ “CN=SomeGroup,DC=er,DC=methodpark,DC=de“  . In order to state the attribute name, which contains the distinguished name of the group members, the attribute
+ groupMemberAttribute  has to be set, e.g. to
+ “member“  in the case of Active Directory.
+A complete example for retrieving group members without using the
+ memberOf  attribute is listed below.
+'' searchFilter="distinguishedName=CN=SomeGroup,DC=er,DC=methodpark,DC=de"\\
+groupMemberAttribute="member“  ''
+=== The ondemandFilter Attribute ===
+This attribute is required for user auto-creation and/or on-demand synchronization mode. It allows the Stages system to query the LDAP server for specific users by their Stages login name. The attribute value a query filter like the searchFilter attribute, except that it is meant for unique queries.
+The ondemandFilter must contain the placeholder character “%” that will be replaced by the username when queries on the LDAP repository are made.
+Example: ''ondemandFilter=“(&(sAMAccountName=%)(objectClass=user))''''”''
+=== The matchUsersMode Attribute ===
+The matchUserMode attribute specifies how LDAP user entries are matched to Stages users when no mapping can be performed using the special _KEY attribute.
+Possible values for the matchUserMode attribute are:
+  * username
+  * fullname
+  * email
+If no explicit value is set for that attribute then the username will be used for that purpose.
+=== The adoptUsers attribute ===
+Stages distinguishes between local user accounts and LDAP user accounts in its user database. The adoptUsers attribute can be used to convert a local user account to an LDAP account if the user can be identified via the matchUserMode attribute. To enable the user account conversion the adoptUser attribute has to be set to “true“. The conversion is disabled by default.
-''<font inherit/Courier New,Courier,monospace;;inherit;;inherit>searchFilter="distinguishedName=CN=SomeGroup,DC=er,DC=methodpark,DC=de"</font>''
+=== The generateDN attribute ===
-The filter specifies that the distinguished name of the (group) entry has to be <font inherit/Courier New,Courier,monospace;;inherit;;inherit>“CN=SomeGroup,DC=er,DC=methodpark,DC=de“</font>. In order to state the attribute name, which contains the distinguished name of the group members, the attribute <font inherit/Courier New,Courier,monospace;;inherit;;inherit>groupMemberAttribute</font> has to be set, e.g. to <font inherit/Courier New,Courier,monospace;;inherit;;inherit>“member“</font> in the case of Active Directory.
+If the directory server does not provide a distinguished name attribute for its entries, the generateDn attribute can be set to “true“ to calculate the distinguished name automatically.
-A complete example for retrieving group members without using the <font inherit/Courier New,Courier,monospace;;inherit;;inherit>memberOf</font>attribute is listed below.
+=== The defaultLicenseType attribute ===
-''<font inherit/Courier New,Courier,monospace;;inherit;;inherit>searchFilter="distinguishedName=CN=SomeGroup,DC=er,DC=methodpark,DC=de"\\
+The defaultLicenseType attribute specifies which license type shall be granted to a newly created LDAP user. Possible values for that attribute are:
-groupMemberAttribute="member“</font>''
-===   ===
+  * Stages Process Modeler (floating): **QM**
+  * Stages Process Modeler (named): **PersonalQM**
+  * Stages Project Manager (floating:) **FloatingPM**
+  * Stages Project Manager (named): **PM**
+  * Stages Process Participant (floating): **FloatingDev**
+  * Stages Process Participant (named): **Dev**
+  * Stages Process Contributor (floating): **FloatingADev**
+  * Stages Process Contributor (named): **ADev**
+  * Stages Process Viewer (floating only): **AuthPsReader**
+  * None: **none**
-\\
+The specified license type is only assigned if the corresponding license limit (named licenses only) for that type is not reached. If the defaultLicenseType attribute is not specified then the value of the configuration property license.types.initialType is used for that purpose. The default value of this property is "Dev".