Skip to main content
Version: Any 26

JobSyncLDAPUser

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

Parameters​

{
"url": "ldap.forumsys.com:389",
"bind_dn": "cn=read-only-admin,dc=example,dc=com",
"bind_password": "*****",
"resolver": "dc=example,dc=com",
"pattern": "(uid=*)",
"main_role": "readonly",
"extended_roles": []
}

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.
  • main_role: readonly, standard or advanced.

  • extended_roles: list of role names. The super_administrator role is not allowed.

  • groups: list of group names.

  • login_attr: LDAP attribute used for the login of the Any user. Default: uid.

  • name_attr: LDAP attribute used for the name of the user in Any. Default: cn.

  • email_attr: LDAP attribute used for the email address of the user in Any. Default: mail.

  • extended_user_metadata: business metadata added to the users. It must first be configured in the user aspect. Each entry follows the syntax "Any metadata": "LDAP metadata":

    "extended_user_metadata": { "employee_number": "employeeNumber" }