Skip to main content
Version: Any 26

JobSyncLDAPGroup

This job synchronizes the Any user groups with those of the LDAP / AD server.

Parameters​

{
"url": "ldap://ldapserver:389",
"resolver": "dc=example,dc=com",
"sync_group": true,
"applications": [],
"group_pattern": "(&(ou=*)(objectClass=groupOfNames))",
"group_main_role": "standard",
"group_extended_roles": [],
"pattern": "(uid=*)",
"main_role": "readonly",
"extended_roles": [],
"overwrite": false,
"overwrite_membership": true,
"extended_user_metadata": {}
}

Connection to the LDAP server​

The url, resolver, pattern, bind_dn, bind_password and use_start_tls parameters define the connection to the LDAP server.

Creation and change of the Any objects​

  • overwrite: set to true to change an existing user or group.
  • sync_group: set to true to create or change the groups in Any. Only the users members of the groups in LDAP are created or changed in Any.
  • applications: list of the application names assigned to the groups in Any.
  • group_main_role: standard or advanced.
  • group_extended_roles: list of role names. The super_administrator role is not allowed.
  • group_name_attr: LDAP attribute used for the name of the group in Any. Default: ou.
  • group_label_attr: LDAP attribute used for the label of the group in Any. Default: cn.
  • group_description_attr: LDAP attribute used for the description of the group in Any. Default: description.
  • overwrite_membership: set to true to change the members of the existing groups.