Skip to main content

Directory

A Directory defines the information returned about a directory.

Properties

NameTypeDescriptionNotes
alias_mapping_namestrThe name of the AD attribute value that will be mapped into comma seperated string value of alias[optional]
certificatebytearray[optional]
directory_attribute_mappingsList[DirectoryAttributeMapping]Directory attribure mappings.[optional]
directory_connectionsList[DirectoryConnection]The connections that you want to connect when syncing.[optional]
directory_syncDirectorySync[optional]
directory_sync_idstrThe UUID of the directory sync[optional]
group_filtersList[GroupFilter]Directory group filters.[optional]
hostnamestrThe hostname of the Directory Can be an IP address or a hostname.[optional]
idstrThe UUID of the Directory.[optional]
namestrThe name of the Directory.[optional]
passwordstrThe password to connect to the Directory with.[optional]
portintThe port to connect to the Directory over.[optional]
root_domain_naming_contextstrThe root domain naming context of the Directory.[optional]
search_basesList[SearchBase]The searchbases that you want to search when syncing.[optional]
typestrThe type of the Directory.[optional]
use_sslboolWhether or not to connect to the Directory using an SSL certificate.[optional]
user_namestrThe username to connect to the Directory with. Value must be a fully distinguished name or UPN.[optional]

Example