ldap3.abstract.entry module

class ldap3.abstract.entry.Entry(dn, cursor)

Bases: ldap3.abstract.entry.EntryBase

The Entry object contains a single LDAP entry. Attributes can be accessed either by sequence, by assignment or as dictionary keys. Keys are not case sensitive.

The Entry object is read only

  • The DN is retrieved by _dn()
  • The Reader reference is in _cursor()
  • Raw attributes values are retrieved by the _ra_attributes and _raw_attribute() methods
entry_writable(object_def=None, writer_cursor=None, attributes=None, custom_validator=None)
class ldap3.abstract.entry.EntryBase(dn, cursor)

Bases: object

The Entry object contains a single LDAP entry. Attributes can be accessed either by sequence, by assignment or as dictionary keys. Keys are not case sensitive.

The Entry object is read only

  • The DN is retrieved by _dn
  • The cursor reference is in _cursor
  • Raw attributes values are retrieved with _raw_attributes and the _raw_attribute() methods
entry_attributes
entry_attributes_as_dict
entry_cursor
entry_definition
entry_dn
entry_mandatory_attributes
entry_raw_attribute(name)
Parameters:name – name of the attribute
Returns:raw (unencoded) value of the attribute, None if attribute is not found
entry_raw_attributes
entry_read_time
entry_status
entry_to_json(raw=False, indent=4, sort=True, stream=None, checked_attributes=True, include_empty=True)
entry_to_ldif(all_base64=False, line_separator=None, sort_order=None, stream=None)
class ldap3.abstract.entry.EntryState(dn, cursor)

Bases: object

Contains data on the status of the entry. Does not pollute the Entry __dict__.

set_status(status)
class ldap3.abstract.entry.WritableEntry(dn, cursor)

Bases: ldap3.abstract.entry.EntryBase

entry_changes
entry_commit_changes(refresh=True, controls=None, clear_history=True)
entry_delete()
entry_discard_changes()
entry_move(destination_dn)
entry_refresh(tries=4, seconds=2)

Refreshes the entry from the LDAP Server

entry_rename(new_name)
entry_virtual_attributes