ldapUserSource Data Type

An LDAP server that servers as a source for users and groups.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs wrapped by description
group_context ldapSearchInfo element 0/unbounded group_contexts List of LDAP contexts to search for groups.
guid_attribute string element 0/1   The LDAP attribute that defines a unique ID for each user or group.

Typically GUID for eDirectory and objectGUID for Active Directory
id string element 0/1   A random ID assigned to the LDAP User Source.
mapping keyValuePair element 0/unbounded attribute_map List of LDAP attribute mappings.

These attributes are read and used to populate fields in the imported User object. The key of the mapping is the User field name (ex: firstName, lastName, emailAddress, phone). The value is the LDAP attribute name (ex: givenName, surname, mail, telephoneNumber).

password string element 0/1   The password of the LDAP user.
type string element 0/1   The type of User Source.

The only type that is currently supported is "ldap".
url string element 0/1   The LDAP URL of the server.
user_context ldapSearchInfo element 0/unbounded user_contexts List of LDAP contexts to search for users.
username string element 0/1   The LDAP user that is used to bind to and search the LDAP directory for users and groups.
username_attribute string element 0/1   The LDAP attribute that defines the user's login name.

Typically cn for eDirectory and sAMAccountName for Active Directory
Properties inherited from baseRestObject
href string element 0/1   The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
link link element 0/unbounded links Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

<user_source>
  <id>...</id>
  <url>ldap://ldap.mycompany.com:389</url>
  <type>...</type>
  <username_attribute>cn</username_attribute>
  <guid_attribute>GUID</guid_attribute>
  <attribute_map>
    <mapping>
      <key>...</key>
      <value>...</value>
    </mapping>
  </attribute_map>
  <user_contexts>
    <user_context>
      <base_dn>...</base_dn>
      <filter>...</filter>
      <search_subtree>...</search_subtree>
      <home_dir_config>
        <type>...</type>
        <net_folder_server/>
        <path>...</path>
        <ldap_attribute>...</ldap_attribute>
      </home_dir_config>
    </user_context>
  </user_contexts>
  <group_contexts>
    <group_context>
      <base_dn>...</base_dn>
      <filter>...</filter>
      <search_subtree>...</search_subtree>
      <home_dir_config>
        <type>...</type>
        <net_folder_server/>
        <path>...</path>
        <ldap_attribute>...</ldap_attribute>
      </home_dir_config>
    </group_context>
  </group_contexts>
  <username>...</username>
  <password>...</password>
  <href>...</href>
  <links>
    <link>
      <href>...</href>
      <rel>...</rel>
    </link>
  </links>
</user_source>