LdapUserSource Data Type

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

Properties
name data type description
id string A random ID assigned to the LDAP User Source.
url string The LDAP URL of the server.
type string The type of User Source.

The only type that is currently supported is "ldap".
username_attribute string The LDAP attribute that defines the user's login name.

Typically cn for eDirectory and sAMAccountName for Active Directory
guid_attribute string The LDAP attribute that defines a unique ID for each user or group.

Typically GUID for eDirectory and objectGUID for Active Directory
attribute_map array of KeyValuePair 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).

user_contexts array of LdapSearchInfo List of LDAP contexts to search for users.
group_contexts array of LdapSearchInfo List of LDAP contexts to search for groups.
username string The LDAP user that is used to bind to and search the LDAP directory for users and groups.
password string The password of the LDAP user.
Properties inherited from BaseRestObject
href string The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
links array of Link Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

{
  "id" : "...",
  "url" : "ldap://ldap.mycompany.com:389",
  "type" : "...",
  "username_attribute" : "cn",
  "guid_attribute" : "GUID",
  "attribute_map" : [ {
    "key" : "...",
    "value" : "..."
  }, {
    "key" : "...",
    "value" : "..."
  } ],
  "user_contexts" : [ {
    "base_dn" : "...",
    "filter" : "...",
    "search_subtree" : true,
    "home_dir_config" : {
      "type" : "...",
      "net_folder_server" : { },
      "path" : "...",
      "ldap_attribute" : "..."
    }
  }, {
    "base_dn" : "...",
    "filter" : "...",
    "search_subtree" : true,
    "home_dir_config" : {
      "type" : "...",
      "net_folder_server" : { },
      "path" : "...",
      "ldap_attribute" : "..."
    }
  } ],
  "group_contexts" : [ {
    "base_dn" : "...",
    "filter" : "...",
    "search_subtree" : true,
    "home_dir_config" : {
      "type" : "...",
      "net_folder_server" : { },
      "path" : "...",
      "ldap_attribute" : "..."
    }
  }, {
    "base_dn" : "...",
    "filter" : "...",
    "search_subtree" : true,
    "home_dir_config" : {
      "type" : "...",
      "net_folder_server" : { },
      "path" : "...",
      "ldap_attribute" : "..."
    }
  } ],
  "username" : "...",
  "password" : "...",
  "href" : "...",
  "links" : [ {
    "href" : "...",
    "rel" : "..."
  }, {
    "href" : "...",
    "rel" : "..."
  } ]
}