...
Attribute system name | Attribute display name | Required? | Description | Assignable to | Value type | Example value | ||
|---|---|---|---|---|---|---|---|---|
grouperLoaderLdap | Grouper loader LDAP | required | This is the marker attribute that you assign to a group to mark is as a grouper loader ldap group | Groups | None |
| ||
grouperLoaderLdapType | Grouper loader LDAP type | required | Like the SQL loader, this holds the type of job from the GrouperLoaderType enum, currently the only valid values are LDAP_SIMPLE, LDAP_GROUP_LIST, LDAP_GROUPS_FROM_ATTRIBUTES. Simple is a group loaded from LDAP filter which returns subject ids or identifiers. Group list is an LDAP filter which returns group objects, and the group objects have a list of subjects. Groups from attributes is an LDAP filter that returns subjects which have a multi-valued attribute e.g. affiliations where groups will be created based on subject who have each attribute value | grouperLoaderLdap | Enum | LDAP_SIMPLE | ||
grouperLoaderLdapServerId | Grouper loader LDAP server ID | required | Server ID that is configured in the grouper-loader.properties that identifies the connection information to the LDAP serve. Note, if you use "dn", and dn is not an attribute of the object, then the fully qualified object name will be used | grouperLoaderLdap | String | personLdap (note: depends on your configuration) | ||
grouperLoaderLdapFilter | Grouper loader LDAP filter | required | LDAP filter returns objects that have subjectIds or subjectIdentifiers and group name (if LDAP_GROUP_LIST) | grouperLoaderLdap | String | (affiliation=student) | ||
grouperLoaderLdapSubjectAttribute | Grouper loader LDAP subject attribute name | required, for LDAP_SIMPLE, and LDAP_GROUP_LIST | Attribute name of the filter object result that holds the subject id. | grouperLoaderLdap | String | hasMember, or personId | ||
grouperLoaderLdapGroupAttribute | Grouper loader LDAP group attribute name | required for LDAP_GROUPS_FROM_ATTRIBUTE | Attribute name of the filter object result that holds the group name | grouperLoaderLdap | String | affiliation | ||
grouperLoaderLdapSearchDn | Grouper loader LDAP search base DN | optional | Location that constrains the subtree where the filter is applicable. Note, this is relative to the base DN in the ldap server config in the grouper-loader.properties for this server. This makes the query more efficient | grouperLoaderLdap | String | ou=people | ||
grouperLoaderLdapQuartzCron | Grouper loader LDAP quartz cron | required | Quartz cron config string, e.g. every day at 8am is: 0 0 8 * * ? | grouperLoaderLdap | String | 0 0 8 * * ? | ||
grouperLoaderLdapSourceId | Grouper loader LDAP source ID | optional | Source ID from the sources.xml that narrows the search for subjects. This is optional though makes the loader job more efficient | grouperLoaderLdap | String | schoolPeople | ||
grouperLoaderLdapSubjectIdType | Grouper loader LDAP subject ID type | optional | The type of subject ID. This can be either: subjectId (most efficient, default), subjectIdentifier (2nd most efficient), or subjectIdOrIdentifier | grouperLoaderLdap | Enum | subjectId, subjectIdentifier, subjectIdOrIdentifier | ||
grouperLoaderLdapSearchScope | Grouper loader LDAP search scope | optional | How the deep in the subtree the search will take place. Can be OBJECT_SCOPE, ONELEVEL_SCOPE, or SUBTREE_SCOPE (default) | grouperLoaderLdap | Enum | OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE | ||
grouperLoaderLdapAndGroups | Grouper loader LDAP require in groups | optional | If you want to restrict membership in the dynamic group based on other group(s), put the list of group names here comma-separated. The require groups means if you put a group names in there (e.g. school:community:employee) then it will 'and' that group with the member list from the loader. So only members of the group from the loader query who are also employees will be in the resulting group | grouperLoaderLdap | String | school:community:employee | ||
grouperLoaderLdapPriority | Grouper loader LDAP scheduling priority | optional | Quartz has a fixed threadpool (max configured in the grouper-loader.properties), and when the max is reached, then jobs are prioritized by this integer. The higher the better, and the default if not set is 5. | grouperLoaderLdap | Integer | 5 | ||
grouperLoaderLdapGroupsLike | Grouper loader LDAP groups like | optional, for LDAP_GROUP_LIST only | This should be a sql like string (e.g. school:orgs:%org%_systemOfRecord), and the loader should be able to query group names to | grouperLoaderLdap | String | school:orgs:%org%_systemOfRecord | ||
grouperLoaderLdapExtraAttributes | Grouper loader LDAP extra attributes | optional, for LDAP_GROUP_LIST | Attribute names (comma separated) to get LDAP data for expressions in group name, displayExtension, description | grouperLoaderLdap | String | name, description | ||
grouperLoaderLdapErrorUnresolvable | Grouper loader LDAP error unresolvable | optional | Value could be true or false (default to true). If true, then there will be an error if there are unresolvable subjects in the results. If you know there are subjects in LDAP which are not resolvable by Grouper, set to false, they will be ignored | grouperLoaderLdap | boolean | true or false (default to true) | ||
grouperLoaderLdapGroupNameExpression | Grouper loader LDAP group name expression | optional, for LDAP_GROUP_LIST, or LDAP_GROUPS_FROM_ATTRIBUTES | JEXL expression language fragment that evaluates to the group name (relative in the stem as the group which has the loader definition) | grouperLoaderLdap | String |
| ||
grouperLoaderLdapGroupDisplayExtensionExpression | Grouper loader LDAP group display extension expression | optional, for LDAP_GROUP_LIST, or LDAP_GROUPS_FROM_ATTRIBUTES | JEXL expression language fragment that evaluates to the group display extension | grouperLoaderLdap | String |
| ||
grouperLoaderLdapGroupDescriptionExpression | Grouper loader LDAP group description expression | optional, for LDAP_GROUP_LIST, or LDAP_GROUPS_FROM_ATTRIBUTES | JEXL expression language fragment that evaluates to the group description | grouperLoaderLdap | String |
| ||
grouperLoaderLdapSubjectExpression | Grouper loader LDAP subject expression | optional | JEXL expression language fragment that processes the subject string before passing it to the subject API | grouperLoaderLdap | String |
| ||
grouperLoaderLdapRequireGroups | Grouper loader LDAP require groups | optional | If you want to restrict membership in the dynamic group based on other group(s), put the list of group names here comma-separated. The require groups means if you put a group names in there (e.g. school:community:employee) then it will "and" that group with the member list from the loader. So only members of the group from the loader query who are also employees will be in the resulting group | grouperLoaderLdap | String | school:community:employee | ||
grouperLoaderLdapGroupTypes | Grouper loader LDAP group types | optional, for LDAP_GROUP_LIST, or LDAP_GROUPS_FROM_ATTRIBUTES | Comma separated GroupTypes which will be applied to the loaded groups. The reason this enhancement exists is so we can do a group list filter and attach addIncludeExclude to the groups. Note, if you do this (or use some requireGroups), the group name in the loader query should end in the system of record suffix, which by default is _systemOfRecord. | grouperLoaderLdap | String | addIncludeExclude |
...