Advanced Search

Log In | Not a Member?

Contact ADC

Overview

This header contains well known record, attribute and authentication type constants plus others. The attribute and record constants are generally used with the API calls dsDataNodeAllocateString() and dsBuildListFromStrings() to create proper data type arguments for the search methods in the Directory Services API. The auth constants are used with dsDataNodeAllocateString().

Groups

Search

Node attribute type Constants

Configure

Node attribute type Constants

NSL

Neighborhood Constants

DirectoryService Specific Attribute Type Constants

As a guideline for the attribute types the following legend is used:
eDS1xxxxxx Single Valued Attribute
eDSNxxxxxx Multi-Valued Attribute
NOTE #1: Access controls may prevent any particular client from reading/writting various attribute types. In addition some attribute types may not be stored at all and could also represent "real-time" data generated by the directory node plug-in.
NOTE #2: Attributes in the model are available for records and directory nodes.

DirectoryService

Authentication Type Constants

DirectoryService Other Attribute Type Constants Not Mapped by Directory Node Plugins

Mainly used internally by the DirectoryService Daemon or made available via dsGetDirNodeInfo()

#defines

#define kDS1AttrAdminLimits "dsAttrTypeStandard:AdminLimits" 

Discussion

XML plist indicating what an admin user can edit. Found in kDSStdRecordTypeUsers records.

#define kDS1AttrAdminStatus "dsAttrTypeStandard:AdminStatus" 

Discussion

Retained only for backward compatibility.

#define kDS1AttrAlias "dsAttrTypeStandard:Alias" 

Discussion

Alias attribute, contain pointer to another node/record/attribute.

#define kDS1AttrAliasData "dsAttrTypeStandard:AppleAliasData" 

Discussion

Used to identify alias data.

#define kDS1AttrAlternateDatastoreLocation "dsAttrTypeStandard:AlternateDatastoreLocation" 

Discussion

Unix path used for determining where a user's email is stored.

#define kDS1AttrAttrListRefCount "dsAttrTypeStandard:AttrListRefCount" 

Discussion

Attr List reference count for a process.

#define kDS1AttrAttrListValueRefCount "dsAttrTypeStandard:AttrListValueRefCount" 

Discussion

Attr List Value reference count for a process.

#define kDS1AttrAuthCredential "dsAttrTypeStandard:AuthCredential" 

Discussion

An "auth" credential, to be used to authenticate to other Directory nodes.

#define kDS1AttrAuthenticationHint "dsAttrTypeStandard:AuthenticationHint" 

Discussion

Used to identify the authentication hint phrase.

#define kDS1AttrAuthorityRevocationList "dsAttrTypeStandard:AuthorityRevocationList" 

Discussion

Attribute containing the binary of the authority revocation list. A certificate revocation list that defines certificate authority certificates which are no longer trusted. No user certificates are included in this list. Usually found in kDSStdRecordTypeCertificateAuthority records.

#define kDS1AttrBirthday "dsAttrTypeStandard:Birthday" 

Discussion

Single-valued attribute that defines the user's birthday. Format is x.208 standard YYYYMMDDHHMMSSZ which we will require as GMT time.

#define kDS1AttrBootFile "dsAttrTypeStandard:BootFile" 

Discussion

Attribute type in host or machine records for the name of the kernel that this machine will use by default when NetBooting.

#define kDS1AttrBuildVersion "dsAttrTypeStandard:BuildVersion" 

Discussion

Build version for reference.

#define kDS1AttrCACertificate "dsAttrTypeStandard:CACertificate" 

Discussion

Attribute containing the binary of the certificate of a certificate authority. Its corresponding private key is used to sign certificates. Usually found in kDSStdRecordTypeCertificateAuthority records.

#define kDS1AttrCapabilities "dsAttrTypeStandard:Capabilities" 

Discussion

Used with directory nodes so that clients can "discover" the API capabilities for this Directory Node.

#define kDS1AttrCapacity "dsAttrTypeStandard:Capacity" 

Discussion

Attribute type for the capacity of a resource. found in resource records (kDSStdRecordTypeResources). Example: 50

#define kDS1AttrCategory "dsAttrTypeStandard:Category" 

Discussion

The category of an item used for browsing

#define kDS1AttrCertificateRevocationList "dsAttrTypeStandard:CertificateRevocationList" 

Discussion

Attribute containing the binary of the certificate revocation list. This is a list of certificates which are no longer trusted. Usually found in kDSStdRecordTypeCertificateAuthority records.

#define kDS1AttrChange "dsAttrTypeStandard:Change" 

Discussion

Retained for backward compatibility.

#define kDS1AttrComment "dsAttrTypeStandard:Comment" 

Discussion

Attribute used for unformatted comment.

#define kDS1AttrConfigAvail "dsAttrTypeStandard:ConfigAvail" 

Discussion

Config avail tag.

#define kDS1AttrConfigFile "dsAttrTypeStandard:ConfigFile" 

Discussion

Config file name.

#define kDS1AttrContactGUID "dsAttrTypeStandard:ContactGUID" 

Discussion

Attribute type for the contact GUID of a group. found in group records (kDSStdRecordTypeGroups).

#define kDS1AttrContactPerson "dsAttrTypeStandard:ContactPerson" 

Discussion

Attribute type for the contact person of the machine. Found in host or machine records.

#define kDS1AttrCopyTimestamp "dsAttrTypeStandard:CopyTimestamp" 

Discussion

Timestamp used in local account caching.

#define kDS1AttrCoreFWVersion "dsAttrTypeStandard:CoreFWVersion" 

Discussion

Core FW version for reference.

#define kDS1AttrCreationTimestamp "dsAttrTypeStandard:CreationTimestamp" 

Discussion

Attribute showing date/time of record creation. Format is x.208 standard YYYYMMDDHHMMSSZ which we will require as GMT time.

#define kDS1AttrCrossCertificatePair "dsAttrTypeStandard:CrossCertificatePair" 

Discussion

Attribute containing the binary of a pair of certificates which verify each other. Both certificates have the same level of authority. Usually found in kDSStdRecordTypeCertificateAuthority records.

#define kDS1AttrCSPSearchPath "dsAttrTypeStandard:CSPSearchPath" 

Discussion

Admin user configured custom search path defined by the search node.

#define kDS1AttrDataStamp "dsAttrTypeStandard:DataStamp" 

Discussion

checksum/meta data

#define kDS1AttrDateRecordCreated "dsAttrTypeStandard:DateRecordCreated" 

Discussion

Date of record creation.

#define kDS1AttrDirRefCount "dsAttrTypeStandard:DirRefCount" 

Discussion

Directory reference count for a process.

#define kDS1AttrDistinguishedName "dsAttrTypeStandard:RealName" 

Discussion

Users distinguished or real name

#define kDS1AttrDNSDomain "dsAttrTypeStandard:DNSDomain" 

Discussion

DNS Resolver domain attribute.

#define kDS1AttrDNSNameServer "dsAttrTypeStandard:DNSNameServer" 

Discussion

DNS Resolver nameserver attribute.

#define kDS1AttrENetAddress "dsAttrTypeStandard:ENetAddress" 

Discussion

Single-valued attribute for hardware Ethernet address (MAC address). Found in machine records (kDSStdRecordTypeMachines) and computer records (kDSStdRecordTypeComputers).

#define kDS1AttrExpire "dsAttrTypeStandard:Expire" 

Discussion

Used for expiration date or time depending on association.

#define kDS1AttrFirstName "dsAttrTypeStandard:FirstName" 

Discussion

Used for first name of user or person record.

#define kDS1AttrFunctionalState "dsAttrTypeStandard:FunctionalState" 

Discussion

Functional state of plugin for example.

#define kDS1AttrFWVersion "dsAttrTypeStandard:FWVersion" 

Discussion

FW version for reference.

#define kDS1AttrGeneratedUID "dsAttrTypeStandard:GeneratedUID" 

Discussion

Used for 36 character (128 bit) unique ID. Usually found in user, group, and computer records. An example value is "A579E95E-CDFE-4EBC-B7E7-F2158562170F". The standard format contains 32 hex characters and four hyphen characters.

#define kDS1AttrHomeDirectoryQuota "dsAttrTypeStandard:HomeDirectoryQuota" 

Discussion

Represents the allowed usage for a user's home directory in bytes. Found in user records (kDSStdRecordTypeUsers).

#define kDS1AttrHomeDirectorySoftQuota "dsAttrTypeStandard:HomeDirectorySoftQuota" 

Discussion

Used to define home directory size limit in bytes when user is notified that the hard limit is approaching.

#define kDS1AttrHomeLocOwner "dsAttrTypeStandard:HomeLocOwner" 

Discussion

Represents the owner of a workgroup's shared home directory. Typically found in kDSStdRecordTypeGroups records.

#define kDS1AttrInternetAlias "dsAttrTypeStandard:InetAlias" 

Discussion

Used to track internet alias.

#define kDS1AttrKDCConfigData "dsAttrTypeStandard:KDCConfigData" 

Discussion

Contents of the kdc.conf file.

#define kDS1AttrKerberosRealm "dsAttrTypeStandard:KerberosRealm" 

Discussion

Supports Kerberized SMB Server services.

#define kDS1AttrLastName "dsAttrTypeStandard:LastName" 

Discussion

Used for the last name of user or person record.

#define kDS1AttrLDAPSearchBaseSuffix "dsAttrTypeStandard:LDAPSearchBaseSuffix" 

Discussion

Search base suffix for a LDAP server.

#define kDS1AttrLocation "dsAttrTypeStandard:Location" 

Discussion

Represents the location a service is available from (usually domain name). Typically found in service record types including kDSStdRecordTypeAFPServer, kDSStdRecordTypeLDAPServer, and kDSStdRecordTypeWebServer.

#define kDS1AttrLSPSearchPath "dsAttrTypeStandard:LSPSearchPath" 

Discussion

Local only search path defined by the search node.

#define kDS1AttrMailAttribute "dsAttrTypeStandard:MailAttribute" 

Discussion

Holds the mail account config data.

#define kDS1AttrMapGUID "dsAttrTypeStandard:MapGUID" 

Discussion

Represents the GUID for a record's map.

#define kDS1AttrMCXFlags "dsAttrTypeStandard:MCXFlags" 

Discussion

Used by MCX.

#define kDS1AttrMCXSettings "dsAttrTypeStandard:MCXSettings" 

Discussion

Used by MCX.

#define kDS1AttrMetaAutomountMap "dsAttrTypeStandard:MetaAutomountMap" 

Discussion

Used to query for kDSStdRecordTypeAutomount entries associated with a specific kDSStdRecordTypeAutomountMap.

#define kDS1AttrMiddleName "dsAttrTypeStandard:MiddleName" 

Discussion

Used for the middle name of user or person record.

#define kDS1AttrModificationTimestamp "dsAttrTypeStandard:ModificationTimestamp" 

Discussion

Attribute showing date/time of record modification. Format is x.208 standard YYYYMMDDHHMMSSZ which we will require as GMT time.

#define kDS1AttrNeighborhoodType "dsAttrTypeStandard:NeighborhoodType" 

Discussion

Attribute type in Neighborhood records describing their function.

#define kDS1AttrNetworkNumber "dsAttrTypeStandard:NetworkNumber" 

Discussion

Single-valued attribute that defines a network number. Usually found in network records (kDSStdRecordTypeNetworks)

#define kDS1AttrNetworkView "dsAttrTypeStandard:NetworkView" 

Discussion

The name of the managed network view a computer should use for browsing.

#define kDS1AttrNFSHomeDirectory "dsAttrTypeStandard:NFSHomeDirectory" 

Discussion

Defines a user's home directory mount point on the local machine.

#define kDS1AttrNodeRefCount "dsAttrTypeStandard:NodeRefCount" 

Discussion

Node reference count for a process.

#define kDS1AttrNote "dsAttrTypeStandard:Note" 

Discussion

Note attribute. Commonly used in printer records.

#define kDS1AttrNSPSearchPath "dsAttrTypeStandard:NSPSearchPath" 

Discussion

Automatic search path defined by the search node.

#define kDS1AttrNTDomainComputerAccount "dsAttrTypeStandard:NTDomainComputerAccount" 

Discussion

Supports Kerberized SMB Server services.

#define kDS1AttrOriginalNFSHomeDirectory "dsAttrTypeStandard:OriginalNFSHomeDirectory" 

Discussion

NFS home directory used in local account caching.

#define kDS1AttrOriginalNodeName "dsAttrTypeStandard:OriginalNodeName" 

Discussion

Nodename used in local account caching.

#define kDS1AttrOwner "dsAttrTypeStandard:Owner" 

Discussion

Attribute type for the owner of a record. Typically the value is a LDAP distinguished name.

#define kDS1AttrOwnerGUID "dsAttrTypeStandard:OwnerGUID" 

Discussion

Attribute type for the owner GUID of a group. found in group records (kDSStdRecordTypeGroups).

#define kDS1AttrPassword "dsAttrTypeStandard:Password" 

Discussion

Holds the password or credential value.

#define kDS1AttrPasswordPlus "dsAttrTypeStandard:PasswordPlus" 

Discussion

Holds marker data to indicate possible authentication redirection.

#define kDS1AttrPasswordPolicyOptions "dsAttrTypeStandard:PasswordPolicyOptions" 

Discussion

Collection of password policy options in single attribute. Used in user presets record.

#define kDS1AttrPasswordServerList "dsAttrTypeStandard:PasswordServerList" 

Discussion

Represents the attribute for storing the password server's replication information.

#define kDS1AttrPasswordServerLocation "dsAttrTypeStandard:PasswordServerLocation" 

Discussion

Specifies the IP address or domain name of the Password Server associated with a given directory node. Found in a config record named PasswordServer.

#define kDS1AttrPicture "dsAttrTypeStandard:Picture" 

Discussion

Represents the path of the picture for each user displayed in the login window. Found in user records (kDSStdRecordTypeUsers).

#define kDS1AttrPIDValue "dsAttrTypeStandard:PIDValue" 

Discussion

PID value.

#define kDS1AttrPluginIndex "dsAttrTypeStandard:PluginIndex" 

Discussion

Plugin index for reference.

#define kDS1AttrPort "dsAttrTypeStandard:Port" 

Discussion

Represents the port number a service is available on. Typically found in service record types including kDSStdRecordTypeAFPServer, kDSStdRecordTypeLDAPServer, and kDSStdRecordTypeWebServer.

#define kDS1AttrPresetUserIsAdmin "dsAttrTypeStandard:PresetUserIsAdmin" 

Discussion

Flag to indicate whether users created from this preset are administrators by default. Found in kDSStdRecordTypePresetUsers records.

#define kDS1AttrPrimaryComputerGUID "dsAttrTypeStandard:PrimaryComputerGUID" 

Discussion

Single-valued attribute that defines a primary computer of the computer group. added via extensible object for computer group record type (kDSStdRecordTypeComputerGroups)

#define kDS1AttrPrimaryComputerList "dsAttrTypeStandard:PrimaryComputerList" 

Discussion

The GUID of the computer list with which this computer record is associated.

#define kDS1AttrPrimaryGroupID "dsAttrTypeStandard:PrimaryGroupID" 

Discussion

This is the 32 bit unique ID that represents the primary group a user is part of, or the ID of a group. Format is a signed 32 bit integer represented as a string.

#define kDS1AttrPrimaryNTDomain "dsAttrTypeStandard:PrimaryNTDomain" 

Discussion

Supports Kerberized SMB Server services.

#define kDS1AttrPrinter1284DeviceID "dsAttrTypeStandard:Printer1284DeviceID" 

Discussion

Single-valued attribute that defines the IEEE 1284 DeviceID of a printer. This is used when configuring a printer.

#define kDS1AttrPrinterLPRHost "dsAttrTypeStandard:PrinterLPRHost" 

Discussion

Standard attribute type for kDSStdRecordTypePrinters.

#define kDS1AttrPrinterLPRQueue "dsAttrTypeStandard:PrinterLPRQueue" 

Discussion

Standard attribute type for kDSStdRecordTypePrinters.

#define kDS1AttrPrinterMakeAndModel "dsAttrTypeStandard:PrinterMakeAndModel" 

Discussion

Single-valued attribute for definition of the Printer Make and Model. An example Value would be "HP LaserJet 2200". This would be used to determine the proper PPD file to be used when configuring a printer from the Directory. This attribute is based on the IPP Printing Specification RFC and IETF IPP-LDAP Printer Record.

#define kDS1AttrPrinterType "dsAttrTypeStandard:PrinterType" 

Discussion

Standard attribute type for kDSStdRecordTypePrinters.

#define kDS1AttrPrinterURI "dsAttrTypeStandard:PrinterURI" 

Discussion

Single-valued attribute that defines the URI of a printer "ipp://address" or "smb://server/queue". This is used when configuring a printer. This attribute is based on the IPP Printing Specification RFC and IETF IPP-LDAP Printer Record.

kDSNAttrPrinterXRISupported

#define kDSNAttrPrinterXRISupported "dsAttrTypeStandard:PrinterXRISupported" 

Discussion

Multi-valued attribute that defines additional URIs supported by a printer. This is used when configuring a printer. This attribute is based on the IPP Printing Specification RFC and IETF IPP-LDAP Printer Record.

#define kDS1AttrPrintServiceInfoText "dsAttrTypeStandard:PrintServiceInfoText" 

Discussion

Standard attribute type for kDSStdRecordTypePrinters.

#define kDS1AttrPrintServiceInfoXML "dsAttrTypeStandard:PrintServiceInfoXML" 

Discussion

Standard attribute type for kDSStdRecordTypePrinters.

#define kDS1AttrPrintServiceUserData "dsAttrTypeStandard:PrintServiceUserData" 

Discussion

Single-valued attribute for print quota configuration or statistics (XML data). Found in user records (kDSStdRecordTypeUsers) or print service statistics records (kDSStdRecordTypePrintServiceUser).

#define kDS1AttrProcessName "dsAttrTypeStandard:ProcessName" 

Discussion

Process Name.

#define kDS1AttrProtocolNumber "dsAttrTypeStandard:ProtocolNumber" 

Discussion

Single-valued attribute that defines a protocol number. Usually found in protocol records (kDSStdRecordTypeProtocols)

#define kDS1AttrPwdAgingPolicy "dsAttrTypeStandard:PwdAgingPolicy" 

Discussion

Contains the password aging policy data for an authentication capable record.

#define kDS1AttrRARA "dsAttrTypeStandard:RARA" 

Discussion

Retained only for backward compatibility.

#define kDS1AttrReadOnlyNode "dsAttrTypeStandard:ReadOnlyNode" 

Discussion

Can be found using dsGetDirNodeInfo and will return one of ReadOnly, ReadWrite, or WriteOnly strings. Note that ReadWrite does not imply fully readable or writable

#define kDS1AttrRealUserID "dsAttrTypeStandard:RealUserID" 

Discussion

Used by MCX.

#define kDS1AttrRecordImage "dsAttrTypeStandard:RecordImage" 

Discussion

A binary image of the record and all it's attributes. Has never been supported.

#define kDS1AttrRecRefCount "dsAttrTypeStandard:RecRefCount" 

Discussion

Record reference count for a process.

#define kDS1AttrRefNumTableList "dsAttrTypeStandard:RefNumTableList" 

Discussion

Summary of the reference table entries presented as attr values from the Configure node via dsGetDirNodeInfo.

#define kDS1AttrRelativeDNPrefix "dsAttrTypeStandard:RelativeDNPrefix" 

Discussion

Used to map the first native LDAP attribute type required in the building of the Relative Distinguished Name for LDAP record creation.

#define kDS1AttrRPCNumber "dsAttrTypeStandard:RPCNumber" 

Discussion

Single-valued attribute that defines an RPC number. Usually found in RPC records (kDSStdRecordTypeRPC)

#define kDS1AttrSearchPath "dsAttrTypeStandard:SearchPath" 

Discussion

Search path used by the search node.

#define kDS1AttrSearchPolicy "dsAttrTypeStandard:SearchPolicy" 

Discussion

Search policy for the search node.