Mac Developer Library

Developer

OpenDirectory Framework Reference Open Directory Functions Reference

Options
Deployment Target:

On This Page
Language:

Open Directory Functions Reference

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Swift

import OpenDirectory

Objective-C

@import OpenDirectory;

This document describes the functions, constants, and data types used to interact with Open Directory.

Functions

  • Returns the type ID for the Open Directory context.

    Declaration

    Swift

    func ODContextGetTypeID() -> CFTypeID

    Objective-C

    CFTypeID ODContextGetTypeID ( void );

    Return Value

    The type ID for the Open Directory context.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns a dictionary containing details about a node.

    Declaration

    Swift

    func ODNodeCopyDetails(_ inNode: ODNode!, _ inKeys: CFArray!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<CFDictionary>!

    Objective-C

    CFDictionaryRef ODNodeCopyDetails ( ODNodeRef node, CFArrayRef keys, CFErrorRef *error );

    Parameters

    inNode

    The node.

    inKeys

    An array of keys corresponding to the values returned in the dictionary.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    A dictionary containing details about inNode corresponding to keys specified by inKeys.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns a reference to a record of a node.

    Declaration

    Swift

    func ODNodeCopyRecord(_ inNode: ODNode!, _ inRecordType: String!, _ inRecordName: CFString!, _ inAttributes: AnyObject!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<ODRecord>!

    Objective-C

    ODRecordRef ODNodeCopyRecord ( ODNodeRef node, ODRecordType recordType, CFStringRef recordName, CFTypeRef attributes, CFErrorRef *error );

    Parameters

    inNode

    The node.

    inRecordType

    The type of the record.

    inRecordName

    The name of the record.

    inAttributes

    An array of directory attributes to be copied in addition to the record. Can be NULL.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    A reference to a specified record of inNode.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the names of subnodes for a given node.

    Declaration

    Swift

    func ODNodeCopySubnodeNames(_ inNode: ODNode!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<CFArray>!

    Objective-C

    CFArrayRef ODNodeCopySubnodeNames ( ODNodeRef node, CFErrorRef *error );

    Parameters

    inNode

    The node.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    An array of subnode names.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns an array of attribute types supported by a given node.

    Declaration

    Swift

    func ODNodeCopySupportedAttributes(_ inNode: ODNode!, _ inRecordType: String!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<CFArray>!

    Objective-C

    CFArrayRef ODNodeCopySupportedAttributes ( ODNodeRef node, ODRecordType recordType, CFErrorRef *error );

    Parameters

    inNode

    The node.

    inRecordType

    The record type to list supported attribute types for. Can be NULL.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    An array of supported attribute types.

    Discussion

    If inRecordType is NULL, this function returns all attribute types supported by all record types of the node; otherwise, only attribute types specific to inRecordType are returned.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns an array of the record types supported by a given node.

    Declaration

    Swift

    func ODNodeCopySupportedRecordTypes(_ inNode: ODNode!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<CFArray>!

    Objective-C

    CFArrayRef ODNodeCopySupportedRecordTypes ( ODNodeRef node, CFErrorRef *error );

    Parameters

    inNode

    The node.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    An array of supported record types.

    Discussion

    If inNode does not support checking for supported record types, all possible record types are returned.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns an array of the subnodes of a given node that are currently unreachable.

    Declaration

    Swift

    func ODNodeCopyUnreachableSubnodeNames(_ inNode: ODNode!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<CFArray>!

    Objective-C

    CFArrayRef ODNodeCopyUnreachableSubnodeNames ( ODNodeRef node, CFErrorRef *error );

    Parameters

    inNode

    The node.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    An array of unreachable subnodes, or NULL if all subnodes are reachable.

    Discussion

    This function is typically used to detect unreachable search policy nodes.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns a copy of an existing node.

    Declaration

    Swift

    func ODNodeCreateCopy(_ inAllocator: CFAllocator!, _ inNode: ODNode!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<ODNode>!

    Objective-C

    ODNodeRef ODNodeCreateCopy ( CFAllocatorRef allocator, ODNodeRef node, CFErrorRef *error );

    Parameters

    inAllocator

    The memory allocator to use. If NULL, the default allocator is used.

    inNode

    The node to copy.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    A copy of inNode.

    Discussion

    The copy includes remote credentials used for proxy and node authentication.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Creates a record in a specified node with specified properties.

    Declaration

    Swift

    func ODNodeCreateRecord(_ inNode: ODNode!, _ inRecordType: String!, _ inRecordName: CFString!, _ inAttributes: CFDictionary!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<ODRecord>!

    Objective-C

    ODRecordRef ODNodeCreateRecord ( ODNodeRef node, ODRecordType recordType, CFStringRef recordName, CFDictionaryRef attributeDict, CFErrorRef *error );

    Parameters

    inNode

    The node.

    inRecordType

    The record’s type.

    inRecordName

    The record’s name.

    inAttributes

    A dictionary of key-value pairs representing attributes for the record. Can be NULL.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    The created record.

    Discussion

    The keys in inAttributes can be of type CFStringRef or one of the ODRecordType constants. The values in inAttributes must be of type CFArrayRef, containing elements of type CFStringRef or CFDataRef.

    If any of the attributes in inAttributes fails to be set, the record is deleted and outError is set.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns a new node created with a specified name.

    Declaration

    Swift

    func ODNodeCreateWithName(_ inAllocator: CFAllocator!, _ inSession: ODSession!, _ inNodeName: CFString!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<ODNode>!

    Objective-C

    ODNodeRef ODNodeCreateWithName ( CFAllocatorRef allocator, ODSessionRef session, CFStringRef nodeName, CFErrorRef *error );

    Parameters

    inAllocator

    The memory allocator to use. If NULL, the default allocator is used.

    inSession

    The session to create the node in.

    inNodeName

    The name of the node.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    The created node.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns a new node created with a specified type.

    Declaration

    Swift

    func ODNodeCreateWithNodeType(_ inAllocator: CFAllocator!, _ inSession: ODSession!, _ inType: ODNodeType, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<ODNode>!

    Objective-C

    ODNodeRef ODNodeCreateWithNodeType ( CFAllocatorRef allocator, ODSessionRef session, ODNodeType nodeType, CFErrorRef *error );

    Parameters

    inAllocator

    The memory allocator to use. If NULL, the default allocator is used.

    inSession

    The session to create the node in.

    inType

    The type of the node.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    The created node.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the result of a custom call to a node.

    Declaration

    Swift

    func ODNodeCustomCall(_ inNode: ODNode!, _ inCustomCode: CFIndex, _ inSendData: CFData!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> CFData!

    Objective-C

    CFDataRef ODNodeCustomCall ( ODNodeRef node, CFIndex customCode, CFDataRef data, CFErrorRef *error );

    Parameters

    inNode

    The node.

    inCustomCode

    The custom code to send to the node.

    inSendData

    Data required by inCustomCode. Can be NULL.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    The result of the custom call.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the name of a node.

    Declaration

    Swift

    func ODNodeGetName(_ inNode: ODNode!) -> Unmanaged<CFString>!

    Objective-C

    CFStringRef ODNodeGetName ( ODNodeRef node );

    Parameters

    inNode

    The node.

    Return Value

    The name of inNode.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the type ID for an Open Directory node.

    Declaration

    Swift

    func ODNodeGetTypeID() -> CFTypeID

    Objective-C

    CFTypeID ODNodeGetTypeID ( void );

    Return Value

    The type ID for an Open Directory node.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Sets credentials for interacting with a node.

    Declaration

    Swift

    func ODNodeSetCredentials(_ inNode: ODNode!, _ inRecordType: String!, _ inRecordName: CFString!, _ inPassword: CFString!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODNodeSetCredentials ( ODNodeRef node, ODRecordType recordType, CFStringRef recordName, CFStringRef password, CFErrorRef *error );

    Parameters

    inNode

    The node.

    inRecordType

    The record type that uses the credentials. Can be NULL. The default value is kODRecordTypeUsers.

    inRecordName

    The username to use to authenticate with the node.

    inPassword

    The password to use to authenticate with the node.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the credentials are successfully set; otherwise, false.

    Discussion

    If this function fails, the previous credentials for the node are used.

    This function sets credentials for all references to the node. If you only want to set credentials for a single record referencing the node, use ODRecordSetNodeCredentials instead.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Sets credentials for interacting with a node using a specified authentication method.

    Declaration

    Swift

    func ODNodeSetCredentialsExtended(_ inNode: ODNode!, _ inRecordType: String!, _ inAuthType: String!, _ inAuthItems: CFArray!, _ outAuthItems: UnsafeMutablePointer<Unmanaged<CFArray>?>, _ outContext: UnsafeMutablePointer<Unmanaged<ODContext>?>, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODNodeSetCredentialsExtended ( ODNodeRef node, ODRecordType recordType, ODAuthenticationType authType, CFArrayRef authItems, CFArrayRef *outAuthItems, ODContextRef *outContext, CFErrorRef *error );

    Parameters

    inNode

    The node.

    inRecordType

    The record type that uses the credentials. Can be NULL. The default value is kODRecordTypeUsers.

    inAuthType

    The type of authentication to use.

    inAuthItems

    An array of CFString or CFData objects to be used in the authentication process.

    outAuthItems

    An array of CFData objects returned from the authentication process, if any are returned; NULL otherwise.

    outContext

    The proper context if the authentication attempt requires a context; NULL otherwise. If not NULL, then more calls must be made with the Context to continue the authentication.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if no error occurs; otherwise, false.

    Discussion

    If this function fails, the previous credentials for the node are used.

    This function sets credentials for all references to the node. If you only want to set credentials for a single record referencing the node, use ODRecordSetNodeCredentialsExtended instead.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Sets credentials for interacting with a node with the Kerberos cache.

    Declaration

    Objective-C

    bool ODNodeSetCredentialsUsingKerberosCache ( ODNodeRef node, CFStringRef cacheName, CFErrorRef *error );

    Parameters

    inNode

    The node.

    inCacheName

    The name of the Kerberos cache to use. Can be NULL. By default, the currently active Kerberos cache is used.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the credentials are successfully set; otherwise, false.

    Discussion

    If this function fails, the previous credentials for the node are used.

    This function sets credentials for all references to the node. If you only want to set credentials for a single record referencing the node, use ODRecordSetNodeCredentialsUsingKerberosCache instead.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

    Deprecated in OS X v10.7.

  • Returns results from a query synchronously.

    Declaration

    Swift

    func ODQueryCopyResults(_ inQuery: ODQuery!, _ inAllowPartialResults: Bool, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<CFArray>!

    Objective-C

    CFArrayRef ODQueryCopyResults ( ODQueryRef query, bool allowPartialResults, CFErrorRef *error );

    Parameters

    inQuery

    The query.

    inAllowPartialResults

    If true, only immediately available results are returned; otherwise, the function waits until all results are available.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    The results of the query in an array of ODRecord objects.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Creates a query with a node using provided parameters.

    Declaration

    Swift

    func ODQueryCreateWithNode(_ inAllocator: CFAllocator!, _ inNode: ODNode!, _ inRecordTypeOrList: AnyObject!, _ inAttribute: String!, _ inMatchType: ODMatchType, _ inQueryValueOrList: AnyObject!, _ inReturnAttributeOrList: AnyObject!, _ inMaxResults: CFIndex, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<ODQuery>!

    Objective-C

    ODQueryRef ODQueryCreateWithNode ( CFAllocatorRef allocator, ODNodeRef node, CFTypeRef recordTypeOrList, ODAttributeType attribute, ODMatchType matchType, CFTypeRef queryValueOrList, CFTypeRef returnAttributeOrList, CFIndex maxResults, CFErrorRef *error );

    Parameters

    inAllocator

    The memory allocator to use. If NULL, the default allocator is used.

    inNode

    The node.

    inRecordTypeOrList

    The type or types of record to query. Can be a CFString object for a single type or a CFArray object containing CFString objects for multiple types.

    inAttribute

    The name of the attribute to query.

    inMatchType

    The type of query.

    inQueryValueOrList

    The value or values to query in the attribute. Can be a CFString object or a CFData object for a single value, or a CFArray containing CFString and CFData objects for multiple values.

    inReturnAttributeOrList

    The attribute or attributes to be returned from the query. Can be a CFString object for a single attribute or a CFArray object containing CFString objects for multiple attributes. Passing NULL is equivalent to passing kODAttributeTypeStandardOnly.

    inMaxResults

    The maximum number of values to be returned.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    The created query.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Creates a query for a particular node type using provided parameters.

    Declaration

    Swift

    func ODQueryCreateWithNodeType(_ inAllocator: CFAllocator!, _ inType: ODNodeType, _ inRecordTypeOrList: AnyObject!, _ inAttribute: String!, _ inMatchType: ODMatchType, _ inQueryValueOrList: AnyObject!, _ inReturnAttributeOrList: AnyObject!, _ inMaxResults: CFIndex, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<ODQuery>!

    Objective-C

    ODQueryRef ODQueryCreateWithNodeType ( CFAllocatorRef allocator, ODNodeType nodeType, CFTypeRef recordTypeOrList, ODAttributeType attribute, ODMatchType matchType, CFTypeRef queryValueOrList, CFTypeRef returnAttributeOrList, CFIndex maxResults, CFErrorRef *error );

    Parameters

    inAllocator

    The memory allocator to use. If NULL, the default allocator is used.

    inType

    The node type.

    inRecordTypeOrList

    The type or types of record to query. Can be a CFString object for a single type or a CFArray object containing CFString objects for multiple types.

    inAttribute

    The name of the attribute to query.

    inMatchType

    The type of query.

    inQueryValueOrList

    The value or values to query in the attribute. Can be a CFString object or a CFData object for a single value, or a CFArray containing CFString and CFData objects for multiple values.

    inReturnAttributeOrList

    The attribute or attributes to be returned from the query. Can be a CFString object for a single attribute or a CFArray object containing CFString objects for multiple attributes. Passing NULL is equivalent to passing kODAttributeTypeStandardOnly.

    inMaxResults

    The maximum number of values to be returned.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    The created query.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the type ID for an Open Directory query.

    Declaration

    Swift

    func ODQueryGetTypeID() -> CFTypeID

    Objective-C

    CFTypeID ODQueryGetTypeID ( void );

    Return Value

    The type ID for an Open Directory query.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Retrieves results from a query asynchronously by scheduling the query in a run loop.

    Declaration

    Swift

    func ODQueryScheduleWithRunLoop(_ inQuery: ODQuery!, _ inRunLoop: CFRunLoop!, _ inRunLoopMode: CFString!)

    Objective-C

    void ODQueryScheduleWithRunLoop ( ODQueryRef query, CFRunLoopRef runLoop, CFStringRef runLoopMode );

    Parameters

    inQuery

    The query.

    inRunLoop

    The run loop.

    inRunLoopMode

    The mode of the run loop.

    Discussion

    This function spawns a new thread to execute the query in inRunLoop. When the query is complete, the query’s callback function is called with both inResults and inError set to NULL. To remove an incomplete query from its run loop, call ODQueryUnscheduleFromRunLoop.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Sets the callback for an asynchronous query.

    Declaration

    Swift

    func ODQuerySetCallback(_ inQuery: ODQuery!, _ inCallback: ODQueryCallback, _ inUserInfo: UnsafeMutablePointer<Void>)

    Objective-C

    void ODQuerySetCallback ( ODQueryRef query, ODQueryCallback callback, void *userInfo );

    Parameters

    inQuery

    The query.

    inCallback

    The callback function.

    inUserInfo

    A user-defined pointer to be passed back to the callback function.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

    See Also

    ODQueryCallback

  • Retrieves results from a query asynchronously by adding the query to a dispatch queue.

    Declaration

    Swift

    func ODQuerySetDispatchQueue(_ inQuery: ODQuery!, _ inQueue: dispatch_queue_t!)

    Objective-C

    void ODQuerySetDispatchQueue ( ODQueryRef query, dispatch_queue_t queue );

    Parameters

    inQuery

    The query.

    inQueue

    The dispatch queue.

    Discussion

    When the query is complete, the query’s callback function is called with both inResults and inError set to NULL.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

    See Also

    ODQueryCallback

  • Restarts a query, disposing of any results it has obtained.

    Declaration

    Swift

    func ODQuerySynchronize(_ inQuery: ODQuery!)

    Objective-C

    void ODQuerySynchronize ( ODQueryRef query );

    Parameters

    inQuery

    The query.

    Discussion

    If inQuery was originally scheduled in a run loop with ODQueryScheduleWithRunLoop, the query’s callback function is called with inResults set to NULL, inError.error set to kODErrorQuerySynchronize, and inError.domain set to kODErrorDomainFramework.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Removes a query from a specified run loop.

    Declaration

    Swift

    func ODQueryUnscheduleFromRunLoop(_ inQuery: ODQuery!, _ inRunLoop: CFRunLoop!, _ inRunLoopMode: CFString!)

    Objective-C

    void ODQueryUnscheduleFromRunLoop ( ODQueryRef query, CFRunLoopRef runLoop, CFStringRef runLoopMode );

    Parameters

    inQuery

    The query.

    inRunLoop

    The run loop.

    inRunLoopMode

    The mode to remove the query from.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Adds a record as a member of a group record.

    Declaration

    Swift

    func ODRecordAddMember(_ inGroup: ODRecord!, _ inMember: ODRecord!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordAddMember ( ODRecordRef group, ODRecordRef member, CFErrorRef *error );

    Parameters

    inGroup

    The group record.

    inMember

    The record to add.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the record is successfully added; false otherwise.

    Discussion

    Returns an error if inGroup is not a group record or if inMember is not of a type allowed in a group record.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Adds a value to an attribute of a record.

    Declaration

    Swift

    func ODRecordAddValue(_ inRecord: ODRecord!, _ inAttribute: String!, _ inValue: AnyObject!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordAddValue ( ODRecordRef record, ODAttributeType attribute, CFTypeRef value, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    inAttribute

    The attribute.

    inValue

    The value to add to the attribute. Can be a CFStringRef object or a CFDataRef object.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the value is successfully added; false otherwise.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Changes the password of a record.

    Declaration

    Swift

    func ODRecordChangePassword(_ inRecord: ODRecord!, _ inOldPassword: CFString!, _ inNewPassword: CFString!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordChangePassword ( ODRecordRef record, CFStringRef oldPassword, CFStringRef newPassword, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    inOldPassword

    The record’s old password. Pass NULL if the record has no old password.

    inNewPassword

    The record’s new password.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the password is successfully changed; false otherwise.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns whether a group record contains a given record.

    Declaration

    Swift

    func ODRecordContainsMember(_ inGroup: ODRecord!, _ inMember: ODRecord!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordContainsMember ( ODRecordRef group, ODRecordRef member, CFErrorRef *error );

    Parameters

    inGroup

    The group record.

    inMember

    The record to check for membership in the group record..

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if inMember is a member of inGroup; false otherwise.

    Discussion

    This function uses system APIs instead of examining attributes to determine membership,

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the values of a record’s attributes.

    Declaration

    Swift

    func ODRecordCopyDetails(_ inRecord: ODRecord!, _ inAttributes: CFArray!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<CFDictionary>!

    Objective-C

    CFDictionaryRef ODRecordCopyDetails ( ODRecordRef record, CFArrayRef attributes, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    inAttributes

    An array of attributes to return values for. Elements are of type CFStringRef or ODAttributeType. If NULL, all currently fetched values are returned.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    The attribute values of the record.

    Discussion

    The returned values are of type CFString or CFData, depending on the type of attribute. If inAttributes is not NULL and a requested attribute has not been fetched before, it is fetched in order to return its value.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the password policies of a record.

    Declaration

    Objective-C

    CFDictionaryRef ODRecordCopyPasswordPolicy ( CFAllocatorRef allocator, ODRecordRef record, CFErrorRef *error );

    Parameters

    inAllocator

    The memory allocator to use. If NULL, the default allocator is used.

    inRecord

    The record.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    The password policies for the record, or NULL if no policies have been set.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

    Deprecated in OS X v10.9.

  • Returns the value of a single attribute of a record.

    Declaration

    Swift

    func ODRecordCopyValues(_ inRecord: ODRecord!, _ inAttribute: String!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<CFArray>!

    Objective-C

    CFArrayRef ODRecordCopyValues ( ODRecordRef record, ODAttributeType attribute, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    inAttribute

    The attribute.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    The value of the requested attribute, or NULL if the attribute doesn’t exist.

    Discussion

    If the requested attribute has not been fetched before, it is fetched in order to return its value. If the record has been fetched before, internal storage is consulted instead of the directory.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Deletes a record from a node and invalidates the record.

    Declaration

    Swift

    func ODRecordDelete(_ inRecord: ODRecord!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordDelete ( ODRecordRef record, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the record is successfully deleted; otherwise, false.

    Discussion

    After deleting the record, you should release it with the CFRelease function.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the official name of a record.

    Declaration

    Swift

    func ODRecordGetRecordName(_ inRecord: ODRecord!) -> Unmanaged<CFString>!

    Objective-C

    CFStringRef ODRecordGetRecordName ( ODRecordRef record );

    Parameters

    inRecord

    The record.

    Return Value

    The official name of the record.

    Discussion

    The official name of the record typically corresponds to the first value of the kODAttributeTypeRecordName attribute, but not always.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the type of a record.

    Declaration

    Swift

    func ODRecordGetRecordType(_ inRecord: ODRecord!) -> Unmanaged<CFString>!

    Objective-C

    CFStringRef ODRecordGetRecordType ( ODRecordRef record );

    Parameters

    inRecord

    The record.

    Return Value

    The type of the record.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the type ID for a record.

    Declaration

    Swift

    func ODRecordGetTypeID() -> CFTypeID

    Objective-C

    CFTypeID ODRecordGetTypeID ( void );

    Return Value

    The type ID for a record.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Removes a record as a member from a specified group record.

    Declaration

    Swift

    func ODRecordRemoveMember(_ inGroup: ODRecord!, _ inMember: ODRecord!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordRemoveMember ( ODRecordRef group, ODRecordRef member, CFErrorRef *error );

    Parameters

    inGroup

    The group record.

    inMember

    The record to remove.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if inMember is successfully removed from inGroup; otherwise, false.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Removes a value from a record’s attribute.

    Declaration

    Swift

    func ODRecordRemoveValue(_ inRecord: ODRecord!, _ inAttribute: String!, _ inValue: AnyObject!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordRemoveValue ( ODRecordRef record, ODAttributeType attribute, CFTypeRef value, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    inAttribute

    The attribute.

    inValue

    The value to remove.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if inValue is successfully removed from inAttribute; otherwise, false.

    Discussion

    If inValue does not exist, true is returned and no error is set.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Sets node authentication credentials for a given record.

    Declaration

    Swift

    func ODRecordSetNodeCredentials(_ inRecord: ODRecord!, _ inUsername: CFString!, _ inPassword: CFString!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordSetNodeCredentials ( ODRecordRef record, CFStringRef username, CFStringRef password, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    inUsername

    The username to use to authenticate with the node.

    inPassword

    The password to use to authenticate with the node.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the credentials are successfully set; otherwise, false.

    Discussion

    If you want to set credentials for all references to a node, use ODNodeSetCredentials instead.

    If this function fails, the previous credentials are used.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Sets node authentication credentials for a record using a specified authentication method.

    Declaration

    Swift

    func ODRecordSetNodeCredentialsExtended(_ inRecord: ODRecord!, _ inRecordType: String!, _ inAuthType: String!, _ inAuthItems: CFArray!, _ outAuthItems: UnsafeMutablePointer<Unmanaged<CFArray>?>, _ outContext: UnsafeMutablePointer<Unmanaged<ODContext>?>, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordSetNodeCredentialsExtended ( ODRecordRef record, ODRecordType recordType, ODAuthenticationType authType, CFArrayRef authItems, CFArrayRef *outAuthItems, ODContextRef *outContext, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    inRecordType

    The record type that uses the credentials. Can be NULL. The default value is kODRecordTypeUsers.

    inAuthType

    The type of authentication to use.

    inAuthItems

    An array of CFString or CFData objects to be used in the authentication process.

    outAuthItems

    An array of CFData objects returned from the authentication process, if any are returned; NULL otherwise.

    outContext

    The proper context if the authentication attempt requires a context; NULL otherwise. If not NULL, then more calls must be made with the Context to continue the authentication.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if no error occurs; otherwise, false.

    Discussion

    If you want to set credentials for all references to a node, use ODNodeSetCredentialsExtended instead.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Sets credentials for interacting with a record’s node with the Kerberos cache.

    Declaration

    Objective-C

    bool ODRecordSetNodeCredentialsUsingKerberosCache ( ODRecordRef record, CFStringRef cacheName, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    inCacheName

    The name of the Kerberos cache to use. Can be NULL. By default, the currently active Kerberos cache is used.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the credentials are successfully set; otherwise, false.

    Discussion

    If you want to set credentials for all references to a node, use ODNodeSetCredentialsUsingKerberosCache instead.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

    Deprecated in OS X v10.7.

  • Sets one or more attribute values of a record.

    Declaration

    Swift

    func ODRecordSetValue(_ inRecord: ODRecord!, _ inAttribute: String!, _ inValueOrValues: AnyObject!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordSetValue ( ODRecordRef record, ODAttributeType attribute, CFTypeRef valueOrValues, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    inAttribute

    The attribute type to set.

    inValueOrValues

    The value or values. Can be of type CFStringRef or CFDataRef, or a CFArrayRef containing elements of type CFStringRef and CFDataRef.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the value or values are successfully set; otherwise, false.

    Discussion

    Passing an empty array for inValueOrValues deletes the attribute.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Synchronizes a record with the directory to get current data and commit changes.

    Declaration

    Swift

    func ODRecordSynchronize(_ inRecord: ODRecord!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordSynchronize ( ODRecordRef record, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the record is successfully synchronized; otherwise, false.

    Discussion

    This function refetches any attributes which have been fetched previously, but it does not fetch previously unfetched attributes.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Verifies a given password for a record.

    Declaration

    Swift

    func ODRecordVerifyPassword(_ inRecord: ODRecord!, _ inPassword: CFString!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordVerifyPassword ( ODRecordRef record, CFStringRef password, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    inPassword

    The password.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the password is valid; otherwise, false.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Verifies a given password for a record given a specified authentication method.

    Declaration

    Swift

    func ODRecordVerifyPasswordExtended(_ inRecord: ODRecord!, _ inAuthType: String!, _ inAuthItems: CFArray!, _ outAuthItems: UnsafeMutablePointer<Unmanaged<CFArray>?>, _ outContext: UnsafeMutablePointer<Unmanaged<ODContext>?>, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Bool

    Objective-C

    bool ODRecordVerifyPasswordExtended ( ODRecordRef record, ODAuthenticationType authType, CFArrayRef authItems, CFArrayRef *outAuthItems, ODContextRef *outContext, CFErrorRef *error );

    Parameters

    inRecord

    The record.

    inAuthType

    The type of authentication to use.

    inAuthItems

    An array of CFString or CFData objects to be used in the authentication process.

    outAuthItems

    An array of CFData objects returned from the authentication process, if any are returned; NULL otherwise.

    outContext

    The proper context if the authentication attempt requires a context; NULL otherwise. If not NULL, then more calls must be made with the Context to continue the authentication.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    true if the authentication information is valid; otherwise, false.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the names of nodes registered in a given session.

    Declaration

    Swift

    func ODSessionCopyNodeNames(_ inAllocator: CFAllocator!, _ inSession: ODSession!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<CFArray>!

    Objective-C

    CFArrayRef ODSessionCopyNodeNames ( CFAllocatorRef allocator, ODSessionRef session, CFErrorRef *error );

    Parameters

    inAllocator

    The memory allocator to use. If NULL, the default allocator is used.

    inSession

    The session.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    An array of valid node names in the given session.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Creates a session to be passed to node functions.

    Declaration

    Swift

    func ODSessionCreate(_ inAllocator: CFAllocator!, _ inOptions: CFDictionary!, _ outError: UnsafeMutablePointer<Unmanaged<CFError>?>) -> Unmanaged<ODSession>!

    Objective-C

    ODSessionRef ODSessionCreate ( CFAllocatorRef allocator, CFDictionaryRef options, CFErrorRef *error );

    Parameters

    inAllocator

    The memory allocator to use. If NULL, the default allocator is used.

    inOptions

    A dictionary of options to associate with the session.

    outError

    An error reference for error details. Can be NULL.

    Return Value

    The created session.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

  • Returns the type ID for a session.

    Declaration

    Swift

    func ODSessionGetTypeID() -> CFTypeID

    Objective-C

    CFTypeID ODSessionGetTypeID ( void );

    Return Value

    The type ID for a session.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Swift

    import OpenDirectory

    Availability

    Available in OS X v10.6 and later.

Data Types

  • An Open Directory attribute type.

    Declaration

    Objective-C

    typedef _ODAttributeType ODAttributeType;

    Discussion

    See General Attribute Types and Configuration Attribute Types for recognized attribute type values.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

  • An Open Directory authentication type.

    Declaration

    Objective-C

    typedef _ODRecordType ODAuthenticationType;

    Discussion

    See Authentication Types for recognized authentication type values.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

  • An Open Directory context type.

    Declaration

    Objective-C

    typedef struct _ODContext *ODContextRef;

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

  • An Open Directory node type.

    Declaration

    Objective-C

    typedef struct _ODNode *ODNodeRef;

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

  • An Open Directory query type.

    Declaration

    Objective-C

    typedef struct _ODQuery *ODQueryRef;

    Discussion

    Query objects are usually created with ODQueryCreateWithNode or ODQueryCreateWithNodeType.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

  • An Open Directory record type.

    Declaration

    Objective-C

    typedef struct _ODRecord *ODRecordRef;

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

  • An Open Directory session type.

    Declaration

    Objective-C

    typedef struct _ODSessionRef *ODSessionRef;

    Discussion

    Session objects are usually created with ODSessionCreate, and are typically passed to node functions.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

  • An Open Directory match type.

    Declaration

    Objective-C

    typedef uint32_t ODMatchType;

    Discussion

    See Match Types for recognized match type values.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

  • An Open Directory node type.

    Declaration

    Objective-C

    typedef uint32_t ODNodeType;

    Discussion

    See Node Types for recognized node type values.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

  • A callback function called as results from a scheduled query are returned.

    Declaration

    Objective-C

    typedef void (*ODQueryCallback)( ODQueryRef inQuery, CFArrayRef inResults, CFErrorRef inError, void *inUserInfo );

    Discussion

    Results from this function must be retained or copied. The results from any given call are partial. If both inResults and inError are NULL, the query has completed.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

  • An Open Directory record type.

    Declaration

    Objective-C

    typedef _ODRecordType ODRecordType;

    Discussion

    See Record Types for recognized record type values.

    Import Statement

    Objective-C

    @import OpenDirectory;

    Availability

    Available in OS X v10.6 and later.

  • An Open Directory attribute type.

    Declaration

    Objective-C

    #ifdef __OBJC__ typedef NSString * _ODAttributeType; #else typedef CFStringRef _ODAttributeType; #endif

    Discussion

    This is an intermediary type. Use ODAttributeType instead.

    Import Statement

  • An Open Directory authentication type.

    Declaration

    Objective-C

    #ifdef __OBJC__ typedef NSString * _ODAuthenticationType; #else typedef CFStringRef _ODAuthenticationType; #endif

    Discussion

    This is an intermediary type. Use ODAuthenticationType instead.

    Import Statement

  • An Open Directory record type.

    Declaration

    Objective-C

    #ifdef __OBJC__ typedef NSString * _ODRecordType; #else typedef CFStringRef _ODRecordType; #endif

    Discussion

    This is an intermediary type. Use ODRecordType instead.

    Import Statement

Constants

  • Keys used when specifying session information.

    Declaration

    Swift

    var kODSessionDefault: Unmanaged<ODSession>! let kODSessionProxyAddress: CFString! let kODSessionProxyPort: CFString! let kODSessionProxyUsername: CFString! let kODSessionProxyPassword: CFString!

    Objective-C

    ODSessionRef kODSessionDefault; const CFStringRef kODSessionProxyAddress; const CFStringRef kODSessionProxyPort; const CFStringRef kODSessionProxyUsername; const CFStringRef kODSessionProxyPassword;

    Constants

    • kODSessionDefault

      kODSessionDefault

      The default session. Used if there is no need to create a specific reference.

      Available in OS X v10.6 and later.

    • kODSessionProxyAddress

      kODSessionProxyAddress

      The address to connect to via proxy. The value is of type CFString.

      Available in OS X v10.6 and later.

    • kODSessionProxyPort

      kODSessionProxyPort

      The port to connect to via proxy. The value is of type CFNumber.

      Available in OS X v10.6 and later.

    • kODSessionProxyUsername

      kODSessionProxyUsername

      The username to connect with via proxy. The value is of type CFString.

      Available in OS X v10.6 and later.

    • kODSessionProxyPassword

      kODSessionProxyPassword

      The password to connect with via proxy. The value is of type CFString.

      Available in OS X v10.6 and later.

  • Open Directory node types.

    Declaration

    Objective-C

    enum { kODNodeTypeAuthentication = 0x2201, kODNodeTypeContacts = 0x2204, kODNodeTypeNetwork = 0x2205, kODNodeTypeLocalNodes = 0x2200, kODNodeTypeConfigure = 0x2202 };

    Constants

    • kODNodeTypeAuthentication

      kODNodeTypeAuthentication

      A node used for authentication or record lookups.

      Available in OS X v10.6 and later.

    • kODNodeTypeContacts

      kODNodeTypeContacts

      A node used for applications that handle contact data.

      Available in OS X v10.6 and later.

    • kODNodeTypeNetwork

      kODNodeTypeNetwork

      A node used for looking up network resource type data.

      Available in OS X v10.6 and later.

    • kODNodeTypeLocalNodes

      kODNodeTypeLocalNodes

      A node that specifically looks at the local directory.

      Available in OS X v10.6 and later.

    • kODNodeTypeConfigure

      kODNodeTypeConfigure

      A node that specifically refers to the Directory Services configuration.

      Available in OS X v10.6 and later.

  • Types of matches used for searches.

    Declaration

    Objective-C

    enum { kODMatchAny = 0x0001, kODMatchEqualTo = 0x2001, kODMatchBeginsWith = 0x2002, kODMatchEndsWith = 0x2003, kODMatchContains = 0x2004, kODMatchGreaterThan = 0x2006, kODMatchLessThan = 0x2007 kODMatchInsensitiveEqualTo = 0x2101, kODMatchInsensitiveBeginsWith = 0x2102, kODMatchInsensitiveEndsWith = 0x2103, kODMatchInsensitiveContains = 0x2104 };

    Constants

    • kODMatchAny

      kODMatchAny

      A match that returns all records.

    • kODMatchEqualTo

      kODMatchEqualTo

      A match that returns records that are equal to a certain value. This match is case sensitive.

    • kODMatchBeginsWith

      kODMatchBeginsWith

      A match that returns records that begin with a certain value. This match is case sensitive.

    • kODMatchEndsWith

      kODMatchEndsWith

      A match that returns records that end with a certain value. This match is case sensitive.

    • kODMatchContains

      kODMatchContains

      A match that returns records that contain a certain value. This match is case sensitive.

    • kODMatchGreaterThan

      kODMatchGreaterThan

      A match that returns records that are greater than a certain value.

    • kODMatchLessThan

      kODMatchLessThan

      A match that returns records that are less than a certain value.

    • kODMatchInsensitiveEqualTo

      kODMatchInsensitiveEqualTo

      A match that returns records that are equal to a certain value. This match is case insensitive.

    • kODMatchInsensitiveBeginsWith

      kODMatchInsensitiveBeginsWith

      A match that returns records that begin with a certain value. This match is case insensitive.

    • kODMatchInsensitiveEndsWith

      kODMatchInsensitiveEndsWith

      A match that returns records that end with a certain value. This match is case insensitive.

    • kODMatchInsensitiveContains

      kODMatchInsensitiveContains

      A match that returns records that contain a certain value. This match is case insensitive.

  • Types of Open Directory records.

    Declaration

    Swift

    let kODRecordTypeAttributeTypes: String let kODRecordTypeAFPServer: String let kODRecordTypeAliases: String let kODRecordTypeAugments: String let kODRecordTypeAutomount: String let kODRecordTypeAutomountMap: String let kODRecordTypeAutoServerSetup: String let kODRecordTypeBootp: String let kODRecordTypeCertificateAuthorities: String let kODRecordTypeComputerLists: String let kODRecordTypeComputerGroups: String let kODRecordTypeComputers: String let kODRecordTypeConfiguration: String let kODRecordTypeEthernets: String let kODRecordTypeFileMakerServers: String let kODRecordTypeFTPServer: String let kODRecordTypeGroups: String let kODRecordTypeHostServices: String let kODRecordTypeHosts: String let kODRecordTypeLDAPServer: String let kODRecordTypeLocations: String let kODRecordTypeMounts: String let kODRecordTypeNFS: String let kODRecordTypeNetDomains: String let kODRecordTypeNetGroups: String let kODRecordTypeNetworks: String let kODRecordTypePeople: String let kODRecordTypePresetComputers: String let kODRecordTypePresetComputerGroups: String let kODRecordTypePresetComputerLists: String let kODRecordTypePresetGroups: String let kODRecordTypePresetUsers: String let kODRecordTypePrintService: String let kODRecordTypePrintServiceUser: String let kODRecordTypePrinters: String let kODRecordTypeProtocols: String let kODRecordTypeQTSServer: String let kODRecordTypeRecordTypes: String let kODRecordTypeResources: String let kODRecordTypeRPC: String let kODRecordTypeSMBServer: String let kODRecordTypeServer: String let kODRecordTypeServices: String let kODRecordTypeSharePoints: String let kODRecordTypeUsers: String let kODRecordTypeWebServer: String

    Objective-C

    const ODRecordType kODRecordTypeAttributeTypes; const ODRecordType kODRecordTypeAFPServer; const ODRecordType kODRecordTypeAliases; const ODRecordType kODRecordTypeAugments; const ODRecordType kODRecordTypeAutomount; const ODRecordType kODRecordTypeAutomountMap; const ODRecordType kODRecordTypeAutoServerSetup; const ODRecordType kODRecordTypeBootp; const ODRecordType kODRecordTypeCertificateAuthorities; const ODRecordType kODRecordTypeComputerLists; const ODRecordType kODRecordTypeComputerGroups; const ODRecordType kODRecordTypeComputers; const ODRecordType kODRecordTypeConfiguration; const ODRecordType kODRecordTypeEthernets; const ODRecordType kODRecordTypeFileMakerServers; const ODRecordType kODRecordTypeFTPServer; const ODRecordType kODRecordTypeGroups; const ODRecordType kODRecordTypeHostServices; const ODRecordType kODRecordTypeHosts; const ODRecordType kODRecordTypeLDAPServer; const ODRecordType kODRecordTypeLocations; const ODRecordType kODRecordTypeMounts; const ODRecordType kODRecordTypeNFS; const ODRecordType kODRecordTypeNetDomains; const ODRecordType kODRecordTypeNetGroups; const ODRecordType kODRecordTypeNetworks; const ODRecordType kODRecordTypePeople; const ODRecordType kODRecordTypePresetComputers; const ODRecordType kODRecordTypePresetComputerGroups; const ODRecordType kODRecordTypePresetComputerLists; const ODRecordType kODRecordTypePresetGroups; const ODRecordType kODRecordTypePresetUsers; const ODRecordType kODRecordTypePrintService; const ODRecordType kODRecordTypePrintServiceUser; const ODRecordType kODRecordTypePrinters; const ODRecordType kODRecordTypeProtocols; const ODRecordType kODRecordTypeQTSServer; const ODRecordType kODRecordTypeRecordTypes; const ODRecordType kODRecordTypeResources; const ODRecordType kODRecordTypeRPC; const ODRecordType kODRecordTypeSMBServer; const ODRecordType kODRecordTypeServer; const ODRecordType kODRecordTypeServices; const ODRecordType kODRecordTypeSharePoints; const ODRecordType kODRecordTypeUsers; const ODRecordType kODRecordTypeWebServer;

    Constants

    • kODRecordTypeAttributeTypes

      kODRecordTypeAttributeTypes

      A record that represents each possible attribute type.

      Available in OS X v10.6 and later.

    • kODRecordTypeAFPServer

      kODRecordTypeAFPServer

      The record type of an AFP server record.

      Available in OS X v10.6 and later.

    • kODRecordTypeAliases

      kODRecordTypeAliases

      The record type of an alias record.

      Available in OS X v10.6 and later.

    • kODRecordTypeAugments

      kODRecordTypeAugments

      The record type of augmented record data.

      Available in OS X v10.6 and later.

    • kODRecordTypeAutomount

      kODRecordTypeAutomount

      The record type of automount record data.

      Available in OS X v10.6 and later.

    • kODRecordTypeAutomountMap

      kODRecordTypeAutomountMap

      The record type of automount map record data.

      Available in OS X v10.6 and later.

    • kODRecordTypeAutoServerSetup

      kODRecordTypeAutoServerSetup

      The record type used to discover automated server setup information.

      Available in OS X v10.6 and later.

    • kODRecordTypeBootp

      kODRecordTypeBootp

      The record type of a record in the local node for storing bootp information.

      Available in OS X v10.6 and later.

    • kODRecordTypeCertificateAuthorities

      kODRecordTypeCertificateAuthorities

      The record type of a record that contains certificate authority information.

      Available in OS X v10.6 and later.

    • kODRecordTypeComputerLists

      kODRecordTypeComputerLists

      The record type of a computer list record.

      Available in OS X v10.6 and later.

    • kODRecordTypeComputerGroups

      kODRecordTypeComputerGroups

      The record type of a computer group record.

      Available in OS X v10.6 and later.

    • kODRecordTypeComputers

      kODRecordTypeComputers

      The record type of a computer record.

      Available in OS X v10.6 and later.

    • kODRecordTypeConfiguration

      kODRecordTypeConfiguration

      The record type of a configuration record.

      Available in OS X v10.6 and later.

    • kODRecordTypeEthernets

      kODRecordTypeEthernets

      The record type of a record in a node storing ethernet information.

      Available in OS X v10.6 and later.

    • kODRecordTypeFileMakerServers

      kODRecordTypeFileMakerServers

      The record type of a FileMaker server record.

      Available in OS X v10.6 and later.

    • kODRecordTypeFTPServer

      kODRecordTypeFTPServer

      The record type of an FTP server record.

      Available in OS X v10.6 and later.

    • kODRecordTypeGroups

      kODRecordTypeGroups

      The record type of a group record.

      Available in OS X v10.6 and later.

    • kODRecordTypeHostServices

      kODRecordTypeHostServices

      The record type of a record in the local node for storing host services information.

      Available in OS X v10.6 and later.

    • kODRecordTypeHosts

      kODRecordTypeHosts

      The record type of a host record.

      Available in OS X v10.6 and later.

    • kODRecordTypeLDAPServer

      kODRecordTypeLDAPServer

      The record type of an LDAP server record.

      Available in OS X v10.6 and later.

    • kODRecordTypeLocations

      kODRecordTypeLocations

      The record type of a location record.

      Available in OS X v10.6 and later.

    • kODRecordTypeMounts

      kODRecordTypeMounts

      The record type of a mount record.

      Available in OS X v10.6 and later.

    • kODRecordTypeNFS

      kODRecordTypeNFS

      The record type of an NFS record.

      Available in OS X v10.6 and later.

    • kODRecordTypeNetDomains

      kODRecordTypeNetDomains

      The record type of a record in the local node for storing net domain information.

      Available in OS X v10.6 and later.

    • kODRecordTypeNetGroups

      kODRecordTypeNetGroups

      The record type of a record in the local node for storing net group information.

      Available in OS X v10.6 and later.

    • kODRecordTypeNetworks

      kODRecordTypeNetworks

      The record type of a network record.

      Available in OS X v10.6 and later.

    • kODRecordTypePeople

      kODRecordTypePeople

      The record type of a “people” record, used for storing contact information.

      Available in OS X v10.6 and later.

    • kODRecordTypePresetComputers

      kODRecordTypePresetComputers

      The record type used for presets in computer record creation.

      Available in OS X v10.6 and later.

    • kODRecordTypePresetComputerGroups

      kODRecordTypePresetComputerGroups

      The record type used for presets in computer group record creation.

      Available in OS X v10.6 and later.

    • kODRecordTypePresetComputerLists

      kODRecordTypePresetComputerLists

      The record type used for presets in computer list record creation.

      Available in OS X v10.6 and later.

    • kODRecordTypePresetGroups

      kODRecordTypePresetGroups

      The record type used for presets in group record creation.

      Available in OS X v10.6 and later.

    • kODRecordTypePresetUsers

      kODRecordTypePresetUsers

      The record type used for presets in user record creation.

      Available in OS X v10.6 and later.

    • kODRecordTypePrintService

      kODRecordTypePrintService

      The record type of a print service record.

      Available in OS X v10.6 and later.

    • kODRecordTypePrintServiceUser

      kODRecordTypePrintServiceUser

      The record type of a record in the local node for storing a user’s quota usage information.

      Available in OS X v10.6 and later.

    • kODRecordTypePrinters

      kODRecordTypePrinters

      The record type of a printer record.

      Available in OS X v10.6 and later.

    • kODRecordTypeProtocols

      kODRecordTypeProtocols

      The record type of a protocol record.

      Available in OS X v10.6 and later.

    • kODRecordTypeQTSServer

      kODRecordTypeQTSServer

      The record type of a QuickTime streaming server record.

      Available in OS X v10.6 and later.

    • kODRecordTypeRecordTypes

      kODRecordTypeRecordTypes

      A record that represents each possible record type.

      Available in OS X v10.6 and later.

    • kODRecordTypeResources

      kODRecordTypeResources

      The record type of a resource used in group services.

      Available in OS X v10.6 and later.

    • kODRecordTypeRPC

      kODRecordTypeRPC

      The record type of a remote procedure call record.

      Available in OS X v10.6 and later.

    • kODRecordTypeSMBServer

      kODRecordTypeSMBServer

      The record type of an SMB server record.

      Available in OS X v10.6 and later.

    • kODRecordTypeServer

      kODRecordTypeServer

      The record type of a generic server record.

      Available in OS X v10.6 and later.

    • kODRecordTypeServices

      kODRecordTypeServices

      The record type of a directory based service.

      Available in OS X v10.6 and later.

    • kODRecordTypeSharePoints

      kODRecordTypeSharePoints

      The record type of a SharePoint record.

      Available in OS X v10.6 and later.

    • kODRecordTypeUsers

      kODRecordTypeUsers

      The record type of a user record.

      Available in OS X v10.6 and later.

    • kODRecordTypeWebServer

      kODRecordTypeWebServer

      The record type of a web server record.

      Available in OS X v10.6 and later.

  • Types of Open Directory attributes.

    Declaration

    Swift

    let kODAttributeTypeAllAttributes: String let kODAttributeTypeStandardOnly: String let kODAttributeTypeNativeOnly: String let kODAttributeTypeAdminLimits: String let kODAttributeTypeAuthenticationHint: String let kODAttributeTypeAllTypes: String let kODAttributeTypeAuthorityRevocationList: String let kODAttributeTypeBirthday: String let kODAttributeTypeCACertificate: String let kODAttributeTypeCapacity: String let kODAttributeTypeCertificateRevocationList: String let kODAttributeTypeComment: String let kODAttributeTypeContactGUID: String let kODAttributeTypeContactPerson: String let kODAttributeTypeCreationTimestamp: String let kODAttributeTypeCrossCertificatePair: String let kODAttributeTypeDataStamp: String let kODAttributeTypeFullName: String let kODAttributeTypeDNSDomain: String let kODAttributeTypeDNSNameServer: String let kODAttributeTypeENetAddress: String let kODAttributeTypeExpire: String let kODAttributeTypeFirstName: String let kODAttributeTypeGUID: String let kODAttributeTypeHomeDirectoryQuota: String let kODAttributeTypeHomeDirectorySoftQuota: String let kODAttributeTypeHomeLocOwner: String let kODAttributeTypeInternetAlias: String let kODAttributeTypeKDCConfigData: String let kODAttributeTypeKerberosServices: String let kODAttributeTypeLastName: String let kODAttributeTypeLDAPSearchBaseSuffix: String let kODAttributeTypeLocation: String let kODAttributeTypeMapGUID: String let kODAttributeTypeMCXFlags: String let kODAttributeTypeMCXSettings: String let kODAttributeTypeMailAttribute: String let kODAttributeTypeMetaAutomountMap: String let kODAttributeTypeMiddleName: String let kODAttributeTypeModificationTimestamp: String let kODAttributeTypeNFSHomeDirectory: String let kODAttributeTypeNote: String let kODAttributeTypeOwner: String let kODAttributeTypeOwnerGUID: String let kODAttributeTypePassword: String let kODAttributeTypePasswordPlus: String let kODAttributeTypePasswordPolicyOptions: String let kODAttributeTypePasswordServerList: String let kODAttributeTypePasswordServerLocation: String let kODAttributeTypePicture: String let kODAttributeTypePort: String let kODAttributeTypePresetUserIsAdmin: String let kODAttributeTypePrimaryComputerGUID: String let kODAttributeTypePrimaryComputerList: String let kODAttributeTypePrimaryGroupID: String let kODAttributeTypePrinter1284DeviceID: String let kODAttributeTypePrinterLPRHost: String let kODAttributeTypePrinterLPRQueue: String let kODAttributeTypePrinterMakeAndModel: String let kODAttributeTypePrinterType: String let kODAttributeTypePrinterURI: String let kODAttributeTypePrinterXRISupported: String let kODAttributeTypePrintServiceInfoText: String let kODAttributeTypePrintServiceInfoXML: String let kODAttributeTypePrintServiceUserData: String let kODAttributeTypeRealUserID: String let kODAttributeTypeRelativeDNPrefix: String let kODAttributeTypeSMBAcctFlags: String let kODAttributeTypeSMBGroupRID: String let kODAttributeTypeSMBHome: String let kODAttributeTypeSMBHomeDrive: String let kODAttributeTypeSMBKickoffTime: String let kODAttributeTypeSMBLogoffTime: String let kODAttributeTypeSMBLogonTime: String let kODAttributeTypeSMBPrimaryGroupSID: String let kODAttributeTypeSMBPWDLastSet: String let kODAttributeTypeSMBProfilePath: String let kODAttributeTypeSMBRID: String let kODAttributeTypeSMBScriptPath: String let kODAttributeTypeSMBSID: String let kODAttributeTypeSMBUserWorkstations: String let kODAttributeTypeServiceType: String let kODAttributeTypeSetupAdvertising: String let kODAttributeTypeSetupAutoRegister: String let kODAttributeTypeSetupLocation: String let kODAttributeTypeSetupOccupation: String let kODAttributeTypeTimeToLive: String let kODAttributeTypeUniqueID: String let kODAttributeTypeUserCertificate: String let kODAttributeTypeUserPKCS12Data: String let kODAttributeTypeUserShell: String let kODAttributeTypeUserSMIMECertificate: String let kODAttributeTypeVFSDumpFreq: String let kODAttributeTypeVFSLinkDir: String let kODAttributeTypeVFSPassNo: String let kODAttributeTypeVFSType: String let kODAttributeTypeWeblogURI: String let kODAttributeTypeXMLPlist: String let kODAttributeTypeProtocolNumber: String let kODAttributeTypeRPCNumber: String let kODAttributeTypeNetworkNumber: String let kODAttributeTypeAccessControlEntry: String let kODAttributeTypeAddressLine1: String let kODAttributeTypeAddressLine2: String let kODAttributeTypeAddressLine3: String let kODAttributeTypeAreaCode: String let kODAttributeTypeAuthenticationAuthority: String let kODAttributeTypeAutomountInformation: String let kODAttributeTypeBootParams: String let kODAttributeTypeBuilding: String let kODAttributeTypeServicesLocator: String let kODAttributeTypeCity: String let kODAttributeTypeCompany: String let kODAttributeTypeComputers: String let kODAttributeTypeCountry: String let kODAttributeTypeDepartment: String let kODAttributeTypeDNSName: String let kODAttributeTypeEMailAddress: String let kODAttributeTypeEMailContacts: String let kODAttributeTypeFaxNumber: String let kODAttributeTypeGroup: String let kODAttributeTypeGroupMembers: String let kODAttributeTypeGroupMembership: String let kODAttributeTypeGroupServices: String let kODAttributeTypeHomePhoneNumber: String let kODAttributeTypeHTML: String let kODAttributeTypeHomeDirectory: String let kODAttributeTypeIMHandle: String let kODAttributeTypeIPAddress: String let kODAttributeTypeIPAddressAndENetAddress: String let kODAttributeTypeIPv6Address: String let kODAttributeTypeJPEGPhoto: String let kODAttributeTypeJobTitle: String let kODAttributeTypeKDCAuthKey: String let kODAttributeTypeKeywords: String let kODAttributeTypeLDAPReadReplicas: String let kODAttributeTypeLDAPWriteReplicas: String let kODAttributeTypeMapCoordinates: String let kODAttributeTypeMapURI: String let kODAttributeTypeMIME: String let kODAttributeTypeMobileNumber: String let kODAttributeTypeNestedGroups: String let kODAttributeTypeNetGroups: String let kODAttributeTypeNickName: String let kODAttributeTypeOrganizationInfo: String let kODAttributeTypeOrganizationName: String let kODAttributeTypePagerNumber: String let kODAttributeTypePhoneContacts: String let kODAttributeTypePhoneNumber: String let kODAttributeTypePGPPublicKey: String let kODAttributeTypePostalAddress: String let kODAttributeTypePostalAddressContacts: String let kODAttributeTypePostalCode: String let kODAttributeTypeNamePrefix: String let kODAttributeTypeProtocols: String let kODAttributeTypeRecordName: String let kODAttributeTypeRelationships: String let kODAttributeTypeResourceInfo: String let kODAttributeTypeResourceType: String let kODAttributeTypeState: String let kODAttributeTypeStreet: String let kODAttributeTypeNameSuffix: String let kODAttributeTypeURL: String let kODAttributeTypeVFSOpts: String let kODAttributeTypeAlias: String let kODAttributeTypeAuthCredential: String let kODAttributeTypeCopyTimestamp: String let kODAttributeTypeDateRecordCreated: String let kODAttributeTypeKerberosRealm: String let kODAttributeTypeNTDomainComputerAccount: String let kODAttributeTypeOriginalHomeDirectory: String let kODAttributeTypeOriginalNFSHomeDirectory: String let kODAttributeTypeOriginalNodeName: String let kODAttributeTypePrimaryNTDomain: String let kODAttributeTypePwdAgingPolicy: String let kODAttributeTypeReadOnlyNode: String let kODAttributeTypeTimePackage: String let kODAttributeTypeTotalSize: String let kODAttributeTypeAuthMethod: String let kODAttributeTypeMetaNodeLocation: String let kODAttributeTypeNodePath: String let kODAttributeTypePlugInInfo: String let kODAttributeTypeRecordType: String let kODAttributeTypeSchema: String let kODAttributeTypeSubNodes: String let kODAttributeTypeNetGroupTriplet: String let kODAttributeTypeSearchPath: String let kODAttributeTypeSearchPolicy: String let kODAttributeTypeAutomaticSearchPath: String let kODAttributeTypeLocalOnlySearchPath: String let kODAttributeTypeCustomSearchPath: String let kODAttributeTypeAdvertisedServices: String let kODAttributeTypeLocaleRelay: String let kODAttributeTypeLocaleSubnets: String let kODAttributeTypeNetworkInterfaces: String let kODAttributeTypeParentLocales: String let kODAttributeTypePrimaryLocale: String

    Objective-C

    const ODAttributeType kODAttributeTypeAllAttributes; const ODAttributeType kODAttributeTypeStandardOnly; const ODAttributeType kODAttributeTypeNativeOnly; const ODAttributeType kODAttributeTypeAdminLimits; const ODAttributeType kODAttributeTypeAuthenticationHint; const ODAttributeType kODAttributeTypeAllTypes; const ODAttributeType kODAttributeTypeAuthorityRevocationList; const ODAttributeType kODAttributeTypeBirthday; const ODAttributeType kODAttributeTypeCACertificate; const ODAttributeType kODAttributeTypeCapacity; const ODAttributeType kODAttributeTypeCertificateRevocationList; const ODAttributeType kODAttributeTypeComment; const ODAttributeType kODAttributeTypeContactGUID; const ODAttributeType kODAttributeTypeContactPerson; const ODAttributeType kODAttributeTypeCreationTimestamp; const ODAttributeType kODAttributeTypeCrossCertificatePair; const ODAttributeType kODAttributeTypeDataStamp; const ODAttributeType kODAttributeTypeFullName; const ODAttributeType kODAttributeTypeDNSDomain; const ODAttributeType kODAttributeTypeDNSNameServer; const ODAttributeType kODAttributeTypeENetAddress; const ODAttributeType kODAttributeTypeExpire; const ODAttributeType kODAttributeTypeFirstName; const ODAttributeType kODAttributeTypeGUID; const ODAttributeType kODAttributeTypeHomeDirectoryQuota; const ODAttributeType kODAttributeTypeHomeDirectorySoftQuota; const ODAttributeType kODAttributeTypeHomeLocOwner; const ODAttributeType kODAttributeTypeInternetAlias; const ODAttributeType kODAttributeTypeKDCConfigData; const ODAttributeType kODAttributeTypeKerberosServices; const ODAttributeType kODAttributeTypeLastName; const ODAttributeType kODAttributeTypeLDAPSearchBaseSuffix; const ODAttributeType kODAttributeTypeLocation; const ODAttributeType kODAttributeTypeMapGUID; const ODAttributeType kODAttributeTypeMCXFlags; const ODAttributeType kODAttributeTypeMCXSettings; const ODAttributeType kODAttributeTypeMailAttribute; const ODAttributeType kODAttributeTypeMetaAutomountMap; const ODAttributeType kODAttributeTypeMiddleName; const ODAttributeType kODAttributeTypeModificationTimestamp; const ODAttributeType kODAttributeTypeNFSHomeDirectory; const ODAttributeType kODAttributeTypeNote; const ODAttributeType kODAttributeTypeOwner; const ODAttributeType kODAttributeTypeOwnerGUID; const ODAttributeType kODAttributeTypePassword; const ODAttributeType kODAttributeTypePasswordPlus; const ODAttributeType kODAttributeTypePasswordPolicyOptions; const ODAttributeType kODAttributeTypePasswordServerList; const ODAttributeType kODAttributeTypePasswordServerLocation; const ODAttributeType kODAttributeTypePicture; const ODAttributeType kODAttributeTypePort; const ODAttributeType kODAttributeTypePresetUserIsAdmin; const ODAttributeType kODAttributeTypePrimaryComputerGUID; const ODAttributeType kODAttributeTypePrimaryComputerList; const ODAttributeType kODAttributeTypePrimaryGroupID; const ODAttributeType kODAttributeTypePrinter1284DeviceID; const ODAttributeType kODAttributeTypePrinterLPRHost; const ODAttributeType kODAttributeTypePrinterLPRQueue; const ODAttributeType kODAttributeTypePrinterMakeAndModel; const ODAttributeType kODAttributeTypePrinterType; const ODAttributeType kODAttributeTypePrinterURI; const ODAttributeType kODAttributeTypePrinterXRISupported; const ODAttributeType kODAttributeTypePrintServiceInfoText; const ODAttributeType kODAttributeTypePrintServiceInfoXML; const ODAttributeType kODAttributeTypePrintServiceUserData; const ODAttributeType kODAttributeTypeRealUserID; const ODAttributeType kODAttributeTypeRelativeDNPrefix; const ODAttributeType kODAttributeTypeSMBAcctFlags; const ODAttributeType kODAttributeTypeSMBGroupRID; const ODAttributeType kODAttributeTypeSMBHome; const ODAttributeType kODAttributeTypeSMBHomeDrive; const ODAttributeType kODAttributeTypeSMBKickoffTime; const ODAttributeType kODAttributeTypeSMBLogoffTime; const ODAttributeType kODAttributeTypeSMBLogonTime; const ODAttributeType kODAttributeTypeSMBPrimaryGroupSID; const ODAttributeType kODAttributeTypeSMBPWDLastSet; const ODAttributeType kODAttributeTypeSMBProfilePath; const ODAttributeType kODAttributeTypeSMBRID; const ODAttributeType kODAttributeTypeSMBScriptPath; const ODAttributeType kODAttributeTypeSMBSID; const ODAttributeType kODAttributeTypeSMBUserWorkstations; const ODAttributeType kODAttributeTypeServiceType; const ODAttributeType kODAttributeTypeSetupAdvertising; const ODAttributeType kODAttributeTypeSetupAutoRegister; const ODAttributeType kODAttributeTypeSetupLocation; const ODAttributeType kODAttributeTypeSetupOccupation; const ODAttributeType kODAttributeTypeTimeToLive; const ODAttributeType kODAttributeTypeUniqueID; const ODAttributeType kODAttributeTypeUserCertificate; const ODAttributeType kODAttributeTypeUserPKCS12Data; const ODAttributeType kODAttributeTypeUserShell; const ODAttributeType kODAttributeTypeUserSMIMECertificate; const ODAttributeType kODAttributeTypeVFSDumpFreq; const ODAttributeType kODAttributeTypeVFSLinkDir; const ODAttributeType kODAttributeTypeVFSPassNo; const ODAttributeType kODAttributeTypeVFSType; const ODAttributeType kODAttributeTypeWeblogURI; const ODAttributeType kODAttributeTypeXMLPlist; const ODAttributeType kODAttributeTypeProtocolNumber; const ODAttributeType kODAttributeTypeRPCNumber; const ODAttributeType kODAttributeTypeNetworkNumber; const ODAttributeType kODAttributeTypeAccessControlEntry; const ODAttributeType kODAttributeTypeAddressLine1; const ODAttributeType kODAttributeTypeAddressLine2; const ODAttributeType kODAttributeTypeAddressLine3; const ODAttributeType kODAttributeTypeAreaCode; const ODAttributeType kODAttributeTypeAuthenticationAuthority; const ODAttributeType kODAttributeTypeAutomountInformation; const ODAttributeType kODAttributeTypeBootParams; const ODAttributeType kODAttributeTypeBuilding; const ODAttributeType kODAttributeTypeServicesLocator; const ODAttributeType kODAttributeTypeCity; const ODAttributeType kODAttributeTypeCompany; const ODAttributeType kODAttributeTypeComputers; const ODAttributeType kODAttributeTypeCountry; const ODAttributeType kODAttributeTypeDepartment; const ODAttributeType kODAttributeTypeDNSName; const ODAttributeType kODAttributeTypeEMailAddress; const ODAttributeType kODAttributeTypeEMailContacts; const ODAttributeType kODAttributeTypeFaxNumber; const ODAttributeType kODAttributeTypeGroup; const ODAttributeType kODAttributeTypeGroupMembers; const ODAttributeType kODAttributeTypeGroupMembership; const ODAttributeType kODAttributeTypeGroupServices; const ODAttributeType kODAttributeTypeHomePhoneNumber; const ODAttributeType kODAttributeTypeHTML; const ODAttributeType kODAttributeTypeHomeDirectory; const ODAttributeType kODAttributeTypeIMHandle; const ODAttributeType kODAttributeTypeIPAddress; const ODAttributeType kODAttributeTypeIPAddressAndENetAddress; const ODAttributeType kODAttributeTypeIPv6Address; const ODAttributeType kODAttributeTypeJPEGPhoto; const ODAttributeType kODAttributeTypeJobTitle; const ODAttributeType kODAttributeTypeKDCAuthKey; const ODAttributeType kODAttributeTypeKeywords; const ODAttributeType kODAttributeTypeLDAPReadReplicas; const ODAttributeType kODAttributeTypeLDAPWriteReplicas; const ODAttributeType kODAttributeTypeMapCoordinates; const ODAttributeType kODAttributeTypeMapURI; const ODAttributeType kODAttributeTypeMIME; const ODAttributeType kODAttributeTypeMobileNumber; const ODAttributeType kODAttributeTypeNestedGroups; const ODAttributeType kODAttributeTypeNetGroups; const ODAttributeType kODAttributeTypeNickName; const ODAttributeType kODAttributeTypeOrganizationInfo; const ODAttributeType kODAttributeTypeOrganizationName; const ODAttributeType kODAttributeTypePagerNumber; const ODAttributeType kODAttributeTypePhoneContacts; const ODAttributeType kODAttributeTypePhoneNumber; const ODAttributeType kODAttributeTypePGPPublicKey; const ODAttributeType kODAttributeTypePostalAddress; const ODAttributeType kODAttributeTypePostalAddressContacts; const ODAttributeType kODAttributeTypePostalCode; const ODAttributeType kODAttributeTypeNamePrefix; const ODAttributeType kODAttributeTypeProtocols; const ODAttributeType kODAttributeTypeRecordName; const ODAttributeType kODAttributeTypeRelationships; const ODAttributeType kODAttributeTypeResourceInfo; const ODAttributeType kODAttributeTypeResourceType; const ODAttributeType kODAttributeTypeState; const ODAttributeType kODAttributeTypeStreet; const ODAttributeType kODAttributeTypeNameSuffix; const ODAttributeType kODAttributeTypeURL; const ODAttributeType kODAttributeTypeVFSOpts; const ODAttributeType kODAttributeTypeAlias; const ODAttributeType kODAttributeTypeAuthCredential; const ODAttributeType kODAttributeTypeCopyTimestamp; const ODAttributeType kODAttributeTypeDateRecordCreated; const ODAttributeType kODAttributeTypeKerberosRealm; const ODAttributeType kODAttributeTypeNTDomainComputerAccount; const ODAttributeType kODAttributeTypeOriginalHomeDirectory; const ODAttributeType kODAttributeTypeOriginalNFSHomeDirectory; const ODAttributeType kODAttributeTypeOriginalNodeName; const ODAttributeType kODAttributeTypePrimaryNTDomain; const ODAttributeType kODAttributeTypePwdAgingPolicy; const ODAttributeType kODAttributeTypeReadOnlyNode; const ODAttributeType kODAttributeTypeTimePackage; const ODAttributeType kODAttributeTypeTotalSize; const ODAttributeType kODAttributeTypeAuthMethod; const ODAttributeType kODAttributeTypeMetaNodeLocation; const ODAttributeType kODAttributeTypeNodePath; const ODAttributeType kODAttributeTypePlugInInfo; const ODAttributeType kODAttributeTypeRecordType; const ODAttributeType kODAttributeTypeSchema; const ODAttributeType kODAttributeTypeSubNodes; const ODAttributeType kODAttributeTypeNetGroupTriplet; const ODAttributeType kODAttributeTypeSearchPath; const ODAttributeType kODAttributeTypeSearchPolicy; const ODAttributeType kODAttributeTypeAutomaticSearchPath; const ODAttributeType kODAttributeTypeLocalOnlySearchPath; const ODAttributeType kODAttributeTypeCustomSearchPath; const ODAttributeType kODAttributeTypeAdvertisedServices; const ODAttributeType kODAttributeTypeLocaleRelay; const ODAttributeType kODAttributeTypeLocaleSubnets; const ODAttributeType kODAttributeTypeNetworkInterfaces; const ODAttributeType kODAttributeTypeParentLocales; const ODAttributeType kODAttributeTypePrimaryLocale;

    Constants

    • kODAttributeTypeAllAttributes

      kODAttributeTypeAllAttributes

      The attribute type used in requesting all attribute types in a search.

      Available in OS X v10.6 and later.

    • kODAttributeTypeStandardOnly

      kODAttributeTypeStandardOnly

      The attribute type used in requesting only standard attribute types in a search.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNativeOnly

      kODAttributeTypeNativeOnly

      The attribute type used in requesting only native attribute types in a search.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAdminLimits

      kODAttributeTypeAdminLimits

      The attribute type of an XML property list that indicates what an admin user can edit. Found in records of type kODRecordTypeUsers.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAuthenticationHint

      kODAttributeTypeAuthenticationHint

      The attribute type of an authentication hint attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAllTypes

      kODAttributeTypeAllTypes

      The attribute type used to indicate all attribute types for a given record type the config node.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAuthorityRevocationList

      kODAttributeTypeAuthorityRevocationList

      The attribute type of the authority revocation list attribute, which defines certificate authority certificates that are no longer trusted. Typically found in records of type kODRecordTypeCertificateAuthorities.

      Available in OS X v10.6 and later.

    • kODAttributeTypeBirthday

      kODAttributeTypeBirthday

      The attribute type of a birthday attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeCACertificate

      kODAttributeTypeCACertificate

      The attribute type of a certificate authority certificate attribute, which contains the binary of the certificate. Typically found in records of type kODRecordTypeCertificateAuthority.

      Available in OS X v10.6 and later.

    • kODAttributeTypeCapacity

      kODAttributeTypeCapacity

      The attribute type of a capacity attribute, which indicates the capacity of a resource.

      Available in OS X v10.6 and later.

    • kODAttributeTypeCertificateRevocationList

      kODAttributeTypeCertificateRevocationList

      The attribute type of the certificate revocation list attribute, which defines certificates that are no longer trusted. Typically found in records of type kODRecordTypeCertificateAuthorities.

      Available in OS X v10.6 and later.

    • kODAttributeTypeComment

      kODAttributeTypeComment

      The attribute type of an unformatted comment attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeContactGUID

      kODAttributeTypeContactGUID

      The attribute type of the contact GUID attribute. Typically found in records of type kODRecordTypeGroups.

      Available in OS X v10.6 and later.

    • kODAttributeTypeContactPerson

      kODAttributeTypeContactPerson

      The attribute type of the contact person attribute, which indicates the contact person of a machine.

      Available in OS X v10.6 and later.

    • kODAttributeTypeCreationTimestamp

      kODAttributeTypeCreationTimestamp

      The attribute type of the creation timestamp attribute, which indicates the time the record was created.

      Available in OS X v10.6 and later.

    • kODAttributeTypeCrossCertificatePair

      kODAttributeTypeCrossCertificatePair

      The attribute type of the cross certificate attribute, which contains the binary of two certificates that verify one another. Typically found in records of type kODRecordTypeCertificateAuthorities

      Available in OS X v10.6 and later.

    • kODAttributeTypeDataStamp

      kODAttributeTypeDataStamp

      The attribute type of the data stamp attribute, which is used for checksum and accessing metadata.

      Available in OS X v10.6 and later.

    • kODAttributeTypeFullName

      kODAttributeTypeFullName

      The attribute type of the full name attribute, which indicates the full name of the record.

      Available in OS X v10.6 and later.

    • kODAttributeTypeDNSDomain

      kODAttributeTypeDNSDomain

      The attribute type of the DNS domain attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeDNSNameServer

      kODAttributeTypeDNSNameServer

      The attribute type of the DNS name server attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeENetAddress

      kODAttributeTypeENetAddress

      The attribute type of the ethernet address attribute, which specifies a record’s ethernet address (MAC address).

      Available in OS X v10.6 and later.

    • kODAttributeTypeExpire

      kODAttributeTypeExpire

      The attribute type of the expiration attribute, which indicates the expiration date or time of a record.

      Available in OS X v10.6 and later.

    • kODAttributeTypeFirstName

      kODAttributeTypeFirstName

      The attribute type of the first name attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeGUID

      kODAttributeTypeGUID

      The attribute type of the GUID attribute, which indicates a record’s 128-bit GUID.

      Available in OS X v10.6 and later.

    • kODAttributeTypeHomeDirectoryQuota

      kODAttributeTypeHomeDirectoryQuota

      The attribute type of the home directory quota attribute, which is listed in bytes. Typically found in records of type kODRecordTypeUsers.

      Available in OS X v10.6 and later.

    • kODAttributeTypeHomeDirectorySoftQuota

      kODAttributeTypeHomeDirectorySoftQuota

      The attribute type of the home directory soft quota attribute, which is listed in bytes. This specifies a size limit at which users are notified that they are reaching their hard quota. Typically found in records of type kODRecordTypeUsers.

      Available in OS X v10.6 and later.

    • kODAttributeTypeHomeLocOwner

      kODAttributeTypeHomeLocOwner

      The attribute type of the workgroup shared home directory attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeInternetAlias

      kODAttributeTypeInternetAlias

      The attribute type of the internet alias attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeKDCConfigData

      kODAttributeTypeKDCConfigData

      The attribute type of the KDC configuration file attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeKerberosServices

      kODAttributeTypeKerberosServices

      The attribute type of the Kerberos services attribute.

      Available in OS X v10.7 and later.

    • kODAttributeTypeLastName

      kODAttributeTypeLastName

      The attribute type of the last name attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeLDAPSearchBaseSuffix

      kODAttributeTypeLDAPSearchBaseSuffix

      The attribute type of the LDAP server search base suffix attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeLocation

      kODAttributeTypeLocation

      The attribute type of the location attribute, which indicates the domain names a service is available from. Typically found in service record types, such as kODRecordTypeAFPServer, kODRecordTypeLDAPServer, and kODRecordTypeWebServer.

      Available in OS X v10.6 and later.

    • kODAttributeTypeMapGUID

      kODAttributeTypeMapGUID

      The attribute type of the map GUID attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeMCXFlags

      kODAttributeTypeMCXFlags

      The attribute type of the MCX flags attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeMCXSettings

      kODAttributeTypeMCXSettings

      The attribute type of the MCX settings attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeMailAttribute

      kODAttributeTypeMailAttribute

      The attribute type of the mail attribute, which contains mail account configuration data.

      Available in OS X v10.6 and later.

    • kODAttributeTypeMetaAutomountMap

      kODAttributeTypeMetaAutomountMap

      The attribute type used to query for records of type kODRecordTypeAutomount that are associated with a specific record of type kODRecordTypeAutomountMap.

      Available in OS X v10.6 and later.

    • kODAttributeTypeMiddleName

      kODAttributeTypeMiddleName

      The attribute type of the middle name attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeModificationTimestamp

      kODAttributeTypeModificationTimestamp

      The attribute type of the modification timestamp attribute, which indicates the time the record was last modified.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNFSHomeDirectory

      kODAttributeTypeNFSHomeDirectory

      The attribute type of the NFS home directory attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNote

      kODAttributeTypeNote

      The attribute type of the last name attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeOwner

      kODAttributeTypeOwner

      The attribute type of the owner attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeOwnerGUID

      kODAttributeTypeOwnerGUID

      The attribute type of the owner GUID attribute. Typically found in records of type kODRecordTypeGroups.

      Available in OS X v10.6 and later.

    • kODAttributeTypePassword

      kODAttributeTypePassword

      The attribute type of the password attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypePasswordPlus

      kODAttributeTypePasswordPlus

      The attribute type of the attribute that holds marker data to indicate possible authentication redirection.

      Available in OS X v10.6 and later.

    • kODAttributeTypePasswordPolicyOptions

      kODAttributeTypePasswordPolicyOptions

      The attribute type of the password policy options attribute. Typically found in records of type kODRecordTypePresetUsers.

      Available in OS X v10.6 and later.

    • kODAttributeTypePasswordServerList

      kODAttributeTypePasswordServerList

      The attribute type of the password server list attribute, which contains the password server’s replication information.

      Available in OS X v10.6 and later.

    • kODAttributeTypePasswordServerLocation

      kODAttributeTypePasswordServerLocation

      The attribute type of the password server location attribute, which specifies the IP address or domain name of the password server associated with a given directory node.

      Available in OS X v10.6 and later.

    • kODAttributeTypePicture

      kODAttributeTypePicture

      The attribute type of the picture attribute, which specifies the path of the picture for each user displayed in the login window.

      Available in OS X v10.6 and later.

    • kODAttributeTypePort

      kODAttributeTypePort

      The attribute type of the port attribute, which indicates the port number a service is available on.

      Available in OS X v10.6 and later.

    • kODAttributeTypePresetUserIsAdmin

      kODAttributeTypePresetUserIsAdmin

      The attribute type used to indicate whether users created from a given preset are administrators. Typically found in records of type kODRecordTypePresetUsers.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrimaryComputerGUID

      kODAttributeTypePrimaryComputerGUID

      The attribute type used to define the primary computer of a computer group. Typically found in records of type kODRecordTypeComputerGroups

      Available in OS X v10.6 and later.

    • kODAttributeTypePrimaryComputerList

      kODAttributeTypePrimaryComputerList

      The attribute type of the primary computer list attribute, which indicates the computer list a given computer record is associated with.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrimaryGroupID

      kODAttributeTypePrimaryGroupID

      The attribute type used to define a user’s primary group.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrinter1284DeviceID

      kODAttributeTypePrinter1284DeviceID

      The attribute type used to define a printer’s IEEE 1284 device ID.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrinterLPRHost

      kODAttributeTypePrinterLPRHost

      The attribute type used to define a printer’s LPR host.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrinterLPRQueue

      kODAttributeTypePrinterLPRQueue

      The attribute type used to define a printer’s LPR queue.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrinterMakeAndModel

      kODAttributeTypePrinterMakeAndModel

      The attribute type used to define a printer’s make and model. Based on the IPP Printing Specification RFC and IETF IPP-LDAP Printer Record.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrinterType

      kODAttributeTypePrinterType

      The attribute type used to define a printer’s type.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrinterURI

      kODAttributeTypePrinterURI

      The attribute type used to define a printer’s URI. Based on the IPP Printing Specification RFC and IETF IPP-LDAP Printer Record.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrinterXRISupported

      kODAttributeTypePrinterXRISupported

      The attribute type used to define additional URIs supported by a printer. Based on the IPP Printing Specification RFC and IETF IPP-LDAP Printer Record.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrintServiceInfoText

      kODAttributeTypePrintServiceInfoText

      The attribute type used to define a printer’s service info in plaintext.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrintServiceInfoXML

      kODAttributeTypePrintServiceInfoXML

      The attribute type used to define a printer’s service info in XML.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrintServiceUserData

      kODAttributeTypePrintServiceUserData

      The attribute type used to define a printer’s quota configuration and statistics in XML. Typically found in records of type kODRecordTypeUsers or kODRecordTypePrintServiceUser.

      Available in OS X v10.6 and later.

    • kODAttributeTypeRealUserID

      kODAttributeTypeRealUserID

      The attribute type of the real user ID attribute, which is used by Managed Client.

      Available in OS X v10.6 and later.

    • kODAttributeTypeRelativeDNPrefix

      kODAttributeTypeRelativeDNPrefix

      The attribute type used to map the first native LDAP attribute type needed for building a relative distinguished name.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBAcctFlags

      kODAttributeTypeSMBAcctFlags

      The attribute type used as an account control flag.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBGroupRID

      kODAttributeTypeSMBGroupRID

      The attribute type used to define PDC SMB interaction with DirectoryService.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBHome

      kODAttributeTypeSMBHome

      The attribute type used to define the UNC address of a Windows home directory mount point.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBHomeDrive

      kODAttributeTypeSMBHomeDrive

      The attribute type used to define the drive letter of a Windows home directory mount point.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBKickoffTime

      kODAttributeTypeSMBKickoffTime

      The attribute type used to define kickoff time in SMB interaction.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBLogoffTime

      kODAttributeTypeSMBLogoffTime

      The attribute type used to define logoff time in SMB interaction.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBLogonTime

      kODAttributeTypeSMBLogonTime

      The attribute type used to define logon time in SMB interaction.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBPrimaryGroupSID

      kODAttributeTypeSMBPrimaryGroupSID

      The attribute type used to define an SMB primary group’s security ID, which is stored as a string of up to 64 bytes.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBPWDLastSet

      kODAttributeTypeSMBPWDLastSet

      An attribute type used in SMB interaction.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBProfilePath

      kODAttributeTypeSMBProfilePath

      The attribute type used to define desktop management information.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBRID

      kODAttributeTypeSMBRID

      An attribute type used in SMB interaction.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBScriptPath

      kODAttributeTypeSMBScriptPath

      The attribute type used to define an SMB login script path.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBSID

      kODAttributeTypeSMBSID

      The attribute type used to define an SMB security ID, which is stored as a string of up to 64 bytes. Typically found in records of type kODRecordTypeUsers, kODRecordTypeGroups, and kODRecordTypeComputers.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSMBUserWorkstations

      kODAttributeTypeSMBUserWorkstations

      The attribute type used to define a list of workstations a user can log in from.

      Available in OS X v10.6 and later.

    • kODAttributeTypeServiceType

      kODAttributeTypeServiceType

      The attribute type used to define an SMB login script path.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSetupAdvertising

      kODAttributeTypeSetupAdvertising

      The attribute type used to define the raw service type of a service. For instance, a service record of type kODRecordTypeWebServer could have a service of type http or https.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSetupAutoRegister

      kODAttributeTypeSetupAutoRegister

      An attribute type used for automatic population in Setup Assistant.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSetupLocation

      kODAttributeTypeSetupLocation

      An attribute type used for automatic population in Setup Assistant.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSetupOccupation

      kODAttributeTypeSetupOccupation

      An attribute type used for automatic population in Setup Assistant.

      Available in OS X v10.6 and later.

    • kODAttributeTypeTimeToLive

      kODAttributeTypeTimeToLive

      The attribute type used to specify how long to cache a record’s attribute values. Specified in seconds.

      Available in OS X v10.6 and later.

    • kODAttributeTypeUniqueID

      kODAttributeTypeUniqueID

      The attribute type used to define a user’s unique 32-bit ID in the legacy manner.

      Available in OS X v10.6 and later.

    • kODAttributeTypeUserCertificate

      kODAttributeTypeUserCertificate

      The attribute type used to store the binary of a user’s certificate. Typically found in user records.

      Available in OS X v10.6 and later.

    • kODAttributeTypeUserPKCS12Data

      kODAttributeTypeUserPKCS12Data

      The attribute type used to store binary data in PKCS #12 format, including keys and certificates. Typically found in user records.

      Available in OS X v10.6 and later.

    • kODAttributeTypeUserShell

      kODAttributeTypeUserShell

      The attribute type used to specify a user’s shell setting.

      Available in OS X v10.6 and later.

    • kODAttributeTypeUserSMIMECertificate

      kODAttributeTypeUserSMIMECertificate

      The attribute type used to store the binary of a user’s SMIME certificate. Typically found in user records.

      Available in OS X v10.6 and later.

    • kODAttributeTypeVFSDumpFreq

      kODAttributeTypeVFSDumpFreq

      An attribute type used to support mount records.

      Available in OS X v10.6 and later.

    • kODAttributeTypeVFSLinkDir

      kODAttributeTypeVFSLinkDir

      An attribute type used to support mount records.

      Available in OS X v10.6 and later.

    • kODAttributeTypeVFSPassNo

      kODAttributeTypeVFSPassNo

      An attribute type used to support mount records.

      Available in OS X v10.6 and later.

    • kODAttributeTypeVFSType

      kODAttributeTypeVFSType

      An attribute type used to support mount records.

      Available in OS X v10.6 and later.

    • kODAttributeTypeWeblogURI

      kODAttributeTypeWeblogURI

      The attribute type used to specify the URI of a user’s weblog.

      Available in OS X v10.6 and later.

    • kODAttributeTypeXMLPlist

      kODAttributeTypeXMLPlist

      The attribute type used to specify an XML property list.

      Available in OS X v10.6 and later.

    • kODAttributeTypeProtocolNumber

      kODAttributeTypeProtocolNumber

      The attribute type used to specify a protocol number. Typically found in records of type kODRecordTypeProtocols.

      Available in OS X v10.6 and later.

    • kODAttributeTypeRPCNumber

      kODAttributeTypeRPCNumber

      The attribute type used to specify an RPC number.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNetworkNumber

      kODAttributeTypeNetworkNumber

      The attribute type used to specify a network number. Typically found in records of type kODRecordTypeNetworks

      Available in OS X v10.6 and later.

    • kODAttributeTypeAccessControlEntry

      kODAttributeTypeAccessControlEntry

      The attribute type used to store directory access control directives.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAddressLine1

      kODAttributeTypeAddressLine1

      The attribute type used to store the first line of a user’s address data.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAddressLine2

      kODAttributeTypeAddressLine2

      The attribute type used to store the second line of a user’s address data.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAddressLine3

      kODAttributeTypeAddressLine3

      The attribute type used to store the third line of a user’s address data.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAreaCode

      kODAttributeTypeAreaCode

      The attribute type used to store a user’s area code.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAuthenticationAuthority

      kODAttributeTypeAuthenticationAuthority

      The attribute type used to specify the mechanism used to verify or set a user’s password. Typically found in records of type kODRecordTypeUsers

      An authentication authority is a multi-part string divided by semicolons. The “type” component of the string can have the following values:

      • basic indicates a crypt password.

      • ShadowHash indicates a hashed password stored in a secure location.

      • ApplePasswordServer indicates a password originating from password server.

      • Kerberosv5 indicates a Kerberos V5 password.

      • LocalCachedUser indicates a cached user account from another node that uses a ShadowHash password.

      • DisabledUser indicates a disabled account.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAutomountInformation

      kODAttributeTypeAutomountInformation

      The attribute type used to store automount information.

      Available in OS X v10.6 and later.

    • kODAttributeTypeBootParams

      kODAttributeTypeBootParams

      The attribute type used to store boot parameters. Typically found in host or machine records.

      Available in OS X v10.6 and later.

    • kODAttributeTypeBuilding

      kODAttributeTypeBuilding

      The attribute type used to store a user’s building information. Typically found in records of type kODRecordTypeUsers or kODRecordTypePeople.

      Available in OS X v10.6 and later.

    • kODAttributeTypeServicesLocator

      kODAttributeTypeServicesLocator

      The attribute type used to specify the URI of a record’s calendar.

      Available in OS X v10.6 and later.

    • kODAttributeTypeCity

      kODAttributeTypeCity

      The attribute type used to store a user’s city information. Typically found in records of type kODRecordTypeUsers or kODRecordTypePeople.

      Available in OS X v10.6 and later.

    • kODAttributeTypeCompany

      kODAttributeTypeCompany

      The attribute type used to store a user’s company information. Typically found in records of type kODRecordTypeUsers or kODRecordTypePeople.

      Available in OS X v10.6 and later.

    • kODAttributeTypeComputers

      kODAttributeTypeComputers

      The attribute type used to store a list of computers.

      Available in OS X v10.6 and later.

    • kODAttributeTypeCountry

      kODAttributeTypeCountry

      The attribute type used to store a user’s country information. Typically found in records of type kODRecordTypeUsers or kODRecordTypePeople.

      Available in OS X v10.6 and later.

    • kODAttributeTypeDepartment

      kODAttributeTypeDepartment

      The attribute type used to store a user’s department information. Typically found in records of type kODRecordTypeUsers or kODRecordTypePeople.

      Available in OS X v10.6 and later.

    • kODAttributeTypeDNSName

      kODAttributeTypeDNSName

      The attribute type used to specify a DNS resolver nameserver.

      Available in OS X v10.6 and later.

    • kODAttributeTypeEMailAddress

      kODAttributeTypeEMailAddress

      The attribute type used to store a user’s email address. Typically found in records of type kODRecordTypeUsers.

      Available in OS X v10.6 and later.

    • kODAttributeTypeEMailContacts

      kODAttributeTypeEMailContacts

      The attribute type used to store a user’s custom email information. Typically found in records of type kODRecordTypeUsers.

      Available in OS X v10.6 and later.

    • kODAttributeTypeFaxNumber

      kODAttributeTypeFaxNumber

      The attribute type used to store a user’s fax number. Typically found in records of type kODRecordTypeUsers or kODRecordTypePeople.

      Available in OS X v10.6 and later.

    • kODAttributeTypeGroup

      kODAttributeTypeGroup

      The attribute type used to store a list of groups.

      Available in OS X v10.6 and later.

    • kODAttributeTypeGroupMembers

      kODAttributeTypeGroupMembers

      The attribute type used to specify the GUID values of members of a group that are not groups.

      Available in OS X v10.6 and later.

    • kODAttributeTypeGroupMembership

      kODAttributeTypeGroupMembership

      The attribute type used to specify a list of users that belong to a given group.

      Available in OS X v10.6 and later.

    • kODAttributeTypeGroupServices

      kODAttributeTypeGroupServices

      The attribute type used to specify an XML property list that defines a group’s services. Typically found in records of type kODRecordTypeGroups.

      Available in OS X v10.6 and later.

    • kODAttributeTypeHomePhoneNumber

      kODAttributeTypeHomePhoneNumber

      The attribute type used to store a user’s home phone number. Typically found in records of type kODRecordTypeUsers or kODRecordTypePeople.

      Available in OS X v10.6 and later.

    • kODAttributeTypeHTML

      kODAttributeTypeHTML

      The attribute type used to specify an HTML location.

      Available in OS X v10.6 and later.

    • kODAttributeTypeHomeDirectory

      kODAttributeTypeHomeDirectory

      The attribute type used to specify the allowed usage of a user’s home directory in bytes. Typically found in records of type kODRecordTypeUsers.

      Available in OS X v10.6 and later.

    • kODAttributeTypeIMHandle

      kODAttributeTypeIMHandle

      The attribute type used to store a user’s instant messaging handles. Typically found in records of type kODRecordTypeUsers.

      Available in OS X v10.6 and later.

    • kODAttributeTypeIPAddress

      kODAttributeTypeIPAddress

      The attribute type used to specify an IP address.

      Available in OS X v10.6 and later.

    • kODAttributeTypeIPAddressAndENetAddress

      kODAttributeTypeIPAddressAndENetAddress

      The attribute type used to specify a pairing of an IPv4 or IPv6 address with an ethernet address. Typically found in records of type kODRecordTypeComputers.

      Available in OS X v10.6 and later.

    • kODAttributeTypeIPv6Address

      kODAttributeTypeIPv6Address

      The attribute type used to specify an IPv6 address. Typically found in records of type kODRecordTypeComputers and kODRecordTypeHosts.

      Available in OS X v10.6 and later.

    • kODAttributeTypeJPEGPhoto

      kODAttributeTypeJPEGPhoto

      The attribute type used to store binary picture data in JPEG format. Typically found in records of type kODRecordTypeUsers, kODRecordTypePeople, and kODRecordTypeGroups.

      Available in OS X v10.6 and later.

    • kODAttributeTypeJobTitle

      kODAttributeTypeJobTitle

      The attribute type used to store a user’s job title.

      Available in OS X v10.6 and later.

    • kODAttributeTypeKDCAuthKey

      kODAttributeTypeKDCAuthKey

      The attribute type used to store a KDC master key.

      Available in OS X v10.6 and later.

    • kODAttributeTypeKeywords

      kODAttributeTypeKeywords

      The attribute type used to specify keywords for search capability.

      Available in OS X v10.6 and later.

    • kODAttributeTypeLDAPReadReplicas

      kODAttributeTypeLDAPReadReplicas

      The attribute type used to specify a list of LDAP server URLs that can be used to read directory data.

      Available in OS X v10.6 and later.

    • kODAttributeTypeLDAPWriteReplicas

      kODAttributeTypeLDAPWriteReplicas

      The attribute type used to specify a list of LDAP server URLs that can be used to write directory data.

      Available in OS X v10.6 and later.

    • kODAttributeTypeMapCoordinates

      kODAttributeTypeMapCoordinates

      The attribute type used to store coordinates of a user’s location.

      Available in OS X v10.6 and later.

    • kODAttributeTypeMapURI

      kODAttributeTypeMapURI

      The attribute type used to specify the URI of a user’s location.

      Available in OS X v10.6 and later.

    • kODAttributeTypeMIME

      kODAttributeTypeMIME

      The attribute type used to store data of a fully qualified MIME type.

      Available in OS X v10.6 and later.

    • kODAttributeTypeMobileNumber

      kODAttributeTypeMobileNumber

      The attribute type used to store a user’s mobile phone information.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNestedGroups

      kODAttributeTypeNestedGroups

      The attribute type used to specify a list of nested group GUID values in a group attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNetGroups

      kODAttributeTypeNetGroups

      The attribute type used to specify a list of net groups that a user or host record is a member of.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNickName

      kODAttributeTypeNickName

      The attribute type used to store a user’s nickname.

      Available in OS X v10.6 and later.

    • kODAttributeTypeOrganizationInfo

      kODAttributeTypeOrganizationInfo

      The attribute type used to store a user’s organization information.

      Available in OS X v10.6 and later.

    • kODAttributeTypeOrganizationName

      kODAttributeTypeOrganizationName

      The attribute type used to store a user’s organization name.

      Available in OS X v10.6 and later.

    • kODAttributeTypePagerNumber

      kODAttributeTypePagerNumber

      The attribute type used to store a user’s pager number.

      Available in OS X v10.6 and later.

    • kODAttributeTypePhoneContacts

      kODAttributeTypePhoneContacts

      The attribute type used to store a user’s custom phone information.

      Available in OS X v10.6 and later.

    • kODAttributeTypePhoneNumber

      kODAttributeTypePhoneNumber

      The attribute type used to store a user’s phone number.

      Available in OS X v10.6 and later.

    • kODAttributeTypePGPPublicKey

      kODAttributeTypePGPPublicKey

      The attribute type used to specify a Pretty Good Privacy public key.

      Available in OS X v10.6 and later.

    • kODAttributeTypePostalAddress

      kODAttributeTypePostalAddress

      The attribute type used to store a user’s postal address.

      Available in OS X v10.6 and later.

    • kODAttributeTypePostalAddressContacts

      kODAttributeTypePostalAddressContacts

      The attribute type used to store a user’s custom postal address information.

      Available in OS X v10.6 and later.

    • kODAttributeTypePostalCode

      kODAttributeTypePostalCode

      The attribute type used to store a user’s postal code.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNamePrefix

      kODAttributeTypeNamePrefix

      The attribute type used to store a user’s title prefix.

      Available in OS X v10.6 and later.

    • kODAttributeTypeProtocols

      kODAttributeTypeProtocols

      The attribute type used to specify a list of protocols.

      Available in OS X v10.6 and later.

    • kODAttributeTypeRecordName

      kODAttributeTypeRecordName

      The attribute type used to specify a list of names for a record.

      Available in OS X v10.6 and later.

    • kODAttributeTypeRelationships

      kODAttributeTypeRelationships

      The attribute type used to specify a user’s relationships.

      Available in OS X v10.6 and later.

    • kODAttributeTypeResourceInfo

      kODAttributeTypeResourceInfo

      The attribute type used to specify resource record information.

      Available in OS X v10.6 and later.

    • kODAttributeTypeResourceType

      kODAttributeTypeResourceType

      The attribute type used to specify the type of a resource record.

      Available in OS X v10.6 and later.

    • kODAttributeTypeState

      kODAttributeTypeState

      The attribute type used to specify a user’s state or province.

      Available in OS X v10.6 and later.

    • kODAttributeTypeStreet

      kODAttributeTypeStreet

      The attribute type used to specify a user’s street address.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNameSuffix

      kODAttributeTypeNameSuffix

      The attribute type used to specify a user’s title suffix.

      Available in OS X v10.6 and later.

    • kODAttributeTypeURL

      kODAttributeTypeURL

      The attribute type used to specify a list of URLs.

      Available in OS X v10.6 and later.

    • kODAttributeTypeVFSOpts

      kODAttributeTypeVFSOpts

      An attribute type used to support mount records.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAlias

      kODAttributeTypeAlias

      The attribute type used to specify an alias that contains a pointer to another record, node, or attribute.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAuthCredential

      kODAttributeTypeAuthCredential

      The attribute type used to store an authentication credential used to authenticate to a directory.

      Available in OS X v10.6 and later.

    • kODAttributeTypeCopyTimestamp

      kODAttributeTypeCopyTimestamp

      The attribute type used to store a timestamp used in local account caching.

      Available in OS X v10.6 and later.

    • kODAttributeTypeDateRecordCreated

      kODAttributeTypeDateRecordCreated

      The attribute type used to store a record’s creation date.

      Available in OS X v10.6 and later.

    • kODAttributeTypeKerberosRealm

      kODAttributeTypeKerberosRealm

      An attribute type used to support Kerberos SMB server services.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNTDomainComputerAccount

      kODAttributeTypeNTDomainComputerAccount

      An attribute type used to support Kerberos SMB server services.

      Available in OS X v10.6 and later.

    • kODAttributeTypeOriginalHomeDirectory

      kODAttributeTypeOriginalHomeDirectory

      The attribute type used to store a home directory URL used in local account caching.

      Available in OS X v10.6 and later.

    • kODAttributeTypeOriginalNFSHomeDirectory

      kODAttributeTypeOriginalNFSHomeDirectory

      The attribute type used to store an NFS home directory URL used in local account caching.

      Available in OS X v10.6 and later.

    • kODAttributeTypeOriginalNodeName

      kODAttributeTypeOriginalNodeName

      The attribute type used to store a node name used in local account caching.

      Available in OS X v10.6 and later.

    • kODAttributeTypePrimaryNTDomain

      kODAttributeTypePrimaryNTDomain

      An attribute type used to support Kerberos SMB server services.

      Available in OS X v10.6 and later.

    • kODAttributeTypePwdAgingPolicy

      kODAttributeTypePwdAgingPolicy

      The attribute type used to store a record’s password aging policy.

      Available in OS X v10.6 and later.

    • kODAttributeTypeReadOnlyNode

      kODAttributeTypeReadOnlyNode

      The attribute type used to specify a read-only node.

      Available in OS X v10.6 and later.

    • kODAttributeTypeTimePackage

      kODAttributeTypeTimePackage

      The attribute type used to group a record’s creation, modification, and backup timestamps.

      Available in OS X v10.6 and later.

    • kODAttributeTypeTotalSize

      kODAttributeTypeTotalSize

      An attribute type used for checksum and accessing metadata.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAuthMethod

      kODAttributeTypeAuthMethod

      The attribute type used to specify a record’s authentication method.

      Available in OS X v10.6 and later.

    • kODAttributeTypeMetaNodeLocation

      kODAttributeTypeMetaNodeLocation

      The attribute type used to retrieve the registered node name with the directory node plug-in.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNodePath

      kODAttributeTypeNodePath

      The attribute type used in neighborhood records to specify the node to search while looking up aliases in the neighborhood.

      Available in OS X v10.6 and later.

    • kODAttributeTypePlugInInfo

      kODAttributeTypePlugInInfo

      The attribute type used to specify information about the plug-in that is serving a particular directory node.

      Available in OS X v10.6 and later.

    • kODAttributeTypeRecordType

      kODAttributeTypeRecordType

      The attribute type used to specify the type of a record or a directory node.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSchema

      kODAttributeTypeSchema

      The attribute type used to specify a record’s list of attribute types.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSubNodes

      kODAttributeTypeSubNodes

      The attribute type used to specify a node’s list of subnodes.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNetGroupTriplet

      kODAttributeTypeNetGroupTriplet

      The attribute type used to specify a node’s list of subnodes.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSearchPath

      kODAttributeTypeSearchPath

      The attribute type used to specify the search path used by a search node.

      Available in OS X v10.6 and later.

    • kODAttributeTypeSearchPolicy

      kODAttributeTypeSearchPolicy

      The attribute type used to specify the search policy used by a search node.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAutomaticSearchPath

      kODAttributeTypeAutomaticSearchPath

      The attribute type used to specify the automatic search path used by a search node.

      Available in OS X v10.6 and later.

    • kODAttributeTypeLocalOnlySearchPath

      kODAttributeTypeLocalOnlySearchPath

      The attribute type used to specify the local-only search path used by a search node.

      Available in OS X v10.6 and later.

    • kODAttributeTypeCustomSearchPath

      kODAttributeTypeCustomSearchPath

      The attribute type used to specify an admin-configured search path used by a search node.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAdvertisedServices

      kODAttributeTypeAdvertisedServices

      The attribute type used to specify (Bonjour) advertised services.

      Available in OS X v10.7 and later.

    • kODAttributeTypeLocaleRelay

      kODAttributeTypeLocaleRelay

      The attribute type used to specify a relay server for a locale.

      Available in OS X v10.7 and later.

    • kODAttributeTypeLocaleSubnets

      kODAttributeTypeLocaleSubnets

      The attribute type used to specify the subnets for a locale.

      Available in OS X v10.7 and later.

    • kODAttributeTypeNetworkInterfaces

      kODAttributeTypeNetworkInterfaces

      The attribute type used to specify network interfaces.

      Available in OS X v10.7 and later.

    • kODAttributeTypeParentLocales

      kODAttributeTypeParentLocales

      The attribute type for specifying locales of the parent.

      Available in OS X v10.7 and later.

    • kODAttributeTypePrimaryLocale

      kODAttributeTypePrimaryLocale

      The attribute type for specifying the primary locale.

      Available in OS X v10.7 and later.

  • Types of Open Directory attributes specifically for use with configure nodes.

    Declaration

    Swift

    let kODAttributeTypeBuildVersion: String let kODAttributeTypeConfigAvailable: String let kODAttributeTypeConfigFile: String let kODAttributeTypeCoreFWVersion: String let kODAttributeTypeFunctionalState: String let kODAttributeTypeFWVersion: String let kODAttributeTypePluginIndex: String let kODAttributeTypeNumTableList: String let kODAttributeTypeVersion: String let kODAttributeTypePIDValue: String let kODAttributeTypeProcessName: String let kODAttributeTypeTotalRefCount: String let kODAttributeTypeDirRefCount: String let kODAttributeTypeNodeRefCount: String let kODAttributeTypeRecRefCount: String let kODAttributeTypeAttrListRefCount: String let kODAttributeTypeAttrListValueRefCount: String let kODAttributeTypeDirRefs: String let kODAttributeTypeNodeRefs: String let kODAttributeTypeRecRefs: String let kODAttributeTypeAttrListRefs: String let kODAttributeTypeAttrListValueRefs: String

    Objective-C

    kODAttributeTypeBuildVersion kODAttributeTypeConfigAvailable kODAttributeTypeConfigFile kODAttributeTypeCoreFWVersion kODAttributeTypeFunctionalState kODAttributeTypeFWVersion kODAttributeTypePluginIndex kODAttributeTypeNumTableList kODAttributeTypeVersion kODAttributeTypePIDValue kODAttributeTypeProcessName kODAttributeTypeTotalRefCount kODAttributeTypeDirRefCount kODAttributeTypeNodeRefCount kODAttributeTypeRecRefCount kODAttributeTypeAttrListRefCount kODAttributeTypeAttrListValueRefCount kODAttributeTypeDirRefs kODAttributeTypeNodeRefs kODAttributeTypeRecRefs kODAttributeTypeAttrListRefs kODAttributeTypeAttrListValueRef s

    Constants

    • kODAttributeTypeBuildVersion

      kODAttributeTypeBuildVersion

      The attribute type used to specify the build version.

      Available in OS X v10.6 and later.

    • kODAttributeTypeConfigAvailable

      kODAttributeTypeConfigAvailable

      The attribute type for the config available flag.

      Available in OS X v10.6 and later.

    • kODAttributeTypeConfigFile

      kODAttributeTypeConfigFile

      The attribute type used to specify the config file name.

      Available in OS X v10.6 and later.

    • kODAttributeTypeCoreFWVersion

      kODAttributeTypeCoreFWVersion

      The attribute type used to specify the version of the core framework.

      Available in OS X v10.6 and later.

    • kODAttributeTypeFunctionalState

      kODAttributeTypeFunctionalState

      The attribute type used to specify the functional state of the plug-in.

      Available in OS X v10.6 and later.

    • kODAttributeTypeFWVersion

      kODAttributeTypeFWVersion

      The attribute type used to specify the version of the framework.

      Available in OS X v10.6 and later.

    • kODAttributeTypePluginIndex

      kODAttributeTypePluginIndex

      The attribute type used to specify the plug-in index.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNumTableList

      kODAttributeTypeNumTableList

      The attribute type used to summarize reference table entries as attribute values from the configure node.

      Available in OS X v10.6 and later.

    • kODAttributeTypeVersion

      kODAttributeTypeVersion

      The attribute type used to specify the version.

      Available in OS X v10.6 and later.

    • kODAttributeTypePIDValue

      kODAttributeTypePIDValue

      The attribute type used to specify the PID value.

      Available in OS X v10.6 and later.

    • kODAttributeTypeProcessName

      kODAttributeTypeProcessName

      The attribute type used to specify the process name.

      Available in OS X v10.6 and later.

    • kODAttributeTypeTotalRefCount

      kODAttributeTypeTotalRefCount

      The attribute type used to specify the total count of references for a process.

      Available in OS X v10.6 and later.

    • kODAttributeTypeDirRefCount

      kODAttributeTypeDirRefCount

      The attribute type used to specify the total count of directory references for a process.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNodeRefCount

      kODAttributeTypeNodeRefCount

      The attribute type used to specify the total count of node references for a process.

      Available in OS X v10.6 and later.

    • kODAttributeTypeRecRefCount

      kODAttributeTypeRecRefCount

      The attribute type used to specify the total count of record references for a process.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAttrListRefCount

      kODAttributeTypeAttrListRefCount

      The attribute type used to specify the total count of attribute list references for a process.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAttrListValueRefCount

      kODAttributeTypeAttrListValueRefCount

      The attribute type used to specify the total count of attribute list value references for a process.

      Available in OS X v10.6 and later.

    • kODAttributeTypeDirRefs

      kODAttributeTypeDirRefs

      The attribute type used to store the directory references for a process.

      Available in OS X v10.6 and later.

    • kODAttributeTypeNodeRefs

      kODAttributeTypeNodeRefs

      The attribute type used to store the node references for a process.

      Available in OS X v10.6 and later.

    • kODAttributeTypeRecRefs

      kODAttributeTypeRecRefs

      The attribute type used to store the record references for a process.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAttrListRefs

      kODAttributeTypeAttrListRefs

      The attribute type used to store the attribute list references for a process.

      Available in OS X v10.6 and later.

    • kODAttributeTypeAttrListValueRefs

      kODAttributeTypeAttrListValueRefs

      The attribute type used to store the attribute list value references for a process.

      Available in OS X v10.6 and later.

  • Types of authentication available in Open Directory.

    Declaration

    Swift

    let kODAuthenticationType2WayRandom: String let kODAuthenticationType2WayRandomChangePasswd: String let kODAuthenticationTypeAPOP: String let kODAuthenticationTypeCRAM_MD5: String let kODAuthenticationTypeChangePasswd: String let kODAuthenticationTypeClearText: String let kODAuthenticationTypeCrypt: String let kODAuthenticationTypeDIGEST_MD5: String let kODAuthenticationTypeDeleteUser: String let kODAuthenticationTypeGetEffectivePolicy: String let kODAuthenticationTypeGetGlobalPolicy: String let kODAuthenticationTypeGetKerberosPrincipal: String let kODAuthenticationTypeGetPolicy: String let kODAuthenticationTypeGetUserData: String let kODAuthenticationTypeGetUserName: String let kODAuthenticationTypeKerberosTickets: String let kODAuthenticationTypeMPPEMasterKeys: String let kODAuthenticationTypeMSCHAP2: String let kODAuthenticationTypeNTLMv2: String let kODAuthenticationTypeNTLMv2WithSessionKey: String let kODAuthenticationTypeNewUser: String let kODAuthenticationTypeNewUserWithPolicy: String let kODAuthenticationTypeNodeNativeClearTextOK: String let kODAuthenticationTypeNodeNativeNoClearText: String let kODAuthenticationTypeReadSecureHash: String let kODAuthenticationTypeSMBNTv2UserSessionKey: String let kODAuthenticationTypeSMBWorkstationCredentialSessionKey: String let kODAuthenticationTypeSMB_LM_Key: String let kODAuthenticationTypeSMB_NT_Key: String let kODAuthenticationTypeSMB_NT_UserSessionKey: String let kODAuthenticationTypeSMB_NT_WithUserSessionKey: String let kODAuthenticationTypeSetGlobalPolicy: String let kODAuthenticationTypeSetLMHash: String let kODAuthenticationTypeSetNTHash: String let kODAuthenticationTypeSetPassword: String let kODAuthenticationTypeSetPasswordAsCurrent: String let kODAuthenticationTypeSetPolicy: String let kODAuthenticationTypeSetPolicyAsCurrent: String let kODAuthenticationTypeSetUserData: String let kODAuthenticationTypeSetUserName: String let kODAuthenticationTypeSetWorkstationPassword: String let kODAuthenticationTypeWithAuthorizationRef: String let kODAuthenticationTypeWriteSecureHash: String let kODAuthenticationTypeSetCertificateHashAsCurrent: String

    Objective-C

    ODAuthenticationType kODAuthenticationType2WayRandom; ODAuthenticationType kODAuthenticationType2WayRandomChangePasswd; ODAuthenticationType kODAuthenticationTypeAPOP; ODAuthenticationType kODAuthenticationTypeCRAM_MD5; ODAuthenticationType kODAuthenticationTypeChangePasswd; ODAuthenticationType kODAuthenticationTypeClearText; ODAuthenticationType kODAuthenticationTypeCrypt; ODAuthenticationType kODAuthenticationTypeDIGEST_MD5; ODAuthenticationType kODAuthenticationTypeDeleteUser; ODAuthenticationType kODAuthenticationTypeGetEffectivePolicy; ODAuthenticationType kODAuthenticationTypeGetGlobalPolicy; ODAuthenticationType kODAuthenticationTypeGetKerberosPrincipal; ODAuthenticationType kODAuthenticationTypeGetPolicy; ODAuthenticationType kODAuthenticationTypeGetUserData; ODAuthenticationType kODAuthenticationTypeGetUserName; ODAuthenticationType kODAuthenticationTypeKerberosTickets; ODAuthenticationType kODAuthenticationTypeMPPEMasterKeys; ODAuthenticationType kODAuthenticationTypeMSCHAP2; ODAuthenticationType kODAuthenticationTypeNTLMv2; ODAuthenticationType kODAuthenticationTypeNTLMv2WithSessionKey; ODAuthenticationType kODAuthenticationTypeNewUser; ODAuthenticationType kODAuthenticationTypeNewUserWithPolicy; ODAuthenticationType kODAuthenticationTypeNodeNativeClearTextOK; ODAuthenticationType kODAuthenticationTypeNodeNativeNoClearText; ODAuthenticationType kODAuthenticationTypeReadSecureHash; ODAuthenticationType kODAuthenticationTypeSMBNTv2UserSessionKey; ODAuthenticationType kODAuthenticationTypeSMBWorkstationCredentialSessionKey; ODAuthenticationType kODAuthenticationTypeSMB_LM_Key; ODAuthenticationType kODAuthenticationTypeSMB_NT_Key; ODAuthenticationType kODAuthenticationTypeSMB_NT_UserSessionKey; ODAuthenticationType kODAuthenticationTypeSMB_NT_WithUserSessionKey; ODAuthenticationType kODAuthenticationTypeSecureHash; ODAuthenticationType kODAuthenticationTypeSetGlobalPolicy; ODAuthenticationType kODAuthenticationTypeSetLMHash; ODAuthenticationType kODAuthenticationTypeSetNTHash; ODAuthenticationType kODAuthenticationTypeSetPassword; ODAuthenticationType kODAuthenticationTypeSetPasswordAsCurrent; ODAuthenticationType kODAuthenticationTypeSetPolicy; ODAuthenticationType kODAuthenticationTypeSetPolicyAsCurrent; ODAuthenticationType kODAuthenticationTypeSetUserData; ODAuthenticationType kODAuthenticationTypeSetUserName; ODAuthenticationType kODAuthenticationTypeSetWorkstationPassword; ODAuthenticationType kODAuthenticationTypeWithAuthorizationRef; ODAuthenticationType kODAuthenticationTypeWriteSecureHash; const ODAuthenticationType kODAuthenticationTypeSetCertificateHashAsCurrent;

    Constants

    • kODAuthenticationType2WayRandom

      kODAuthenticationType2WayRandom

      The authentication type used to specify two way random authentication.

      Available in OS X v10.6 and later.

    • kODAuthenticationType2WayRandomChangePasswd

      kODAuthenticationType2WayRandomChangePasswd

      The authentication type used to change a user’s password using two way random authentication.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeAPOP

      kODAuthenticationTypeAPOP

      The authentication type used to specify APOP authentication.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeCRAM_MD5

      kODAuthenticationTypeCRAM_MD5

      The authentication type used to specify CRAM MD5 authentication.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeChangePasswd

      kODAuthenticationTypeChangePasswd

      The authentication type used to change a user’s password using CRAM MD5 authentication.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeClearText

      kODAuthenticationTypeClearText

      The authentication type used to specify cleartext authentication.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeCrypt

      kODAuthenticationTypeCrypt

      The authentication type used to specify crypt authentication, which uses a crypt password stored in a user’s record if available.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeDIGEST_MD5

      kODAuthenticationTypeDIGEST_MD5

      The authentication type used to specify digest MD5 authentication.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeDeleteUser

      kODAuthenticationTypeDeleteUser

      The authentication type used to specify that a user on an Apple password server be deleted.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeGetEffectivePolicy

      kODAuthenticationTypeGetEffectivePolicy

      The authentication type used to access the policies applied to a user.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeGetGlobalPolicy

      kODAuthenticationTypeGetGlobalPolicy

      The authentication type used to access the global authentication policy.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeGetKerberosPrincipal

      kODAuthenticationTypeGetKerberosPrincipal

      The authentication type used to access the name of the Kerberos principal.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeGetPolicy

      kODAuthenticationTypeGetPolicy

      The authentication type used to specify that the plug-in should determine the authentication method to use.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeGetUserData

      kODAuthenticationTypeGetUserData

      The authentication type used to access user data on an Apple password server.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeGetUserName

      kODAuthenticationTypeGetUserName

      The authentication type used to access a username on an Apple password server.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeKerberosTickets

      kODAuthenticationTypeKerberosTickets

      The authentication type used to provide write access to LDAP with an existing Kerberos ticket.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeMPPEMasterKeys

      kODAuthenticationTypeMPPEMasterKeys

      The authentication type used to specify master keys for MPPE encryption.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeMSCHAP2

      kODAuthenticationTypeMSCHAP2

      The authentication type used to specify MS-CHAPv2 encryption.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeNTLMv2

      kODAuthenticationTypeNTLMv2

      The authentication type used to verify an NTLMv2 challenge and response.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeNTLMv2WithSessionKey

      kODAuthenticationTypeNTLMv2WithSessionKey

      The authentication type used to verify an NTLMv2 challenge and response and retrieve session keys in a single call.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeNewUser

      kODAuthenticationTypeNewUser

      The authentication type used to create a new user on an Apple password server.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeNewUserWithPolicy

      kODAuthenticationTypeNewUserWithPolicy

      The authentication type used to create a new user with specified policy settings on an Apple password server.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeNodeNativeClearTextOK

      kODAuthenticationTypeNodeNativeClearTextOK

      The authentication type used to specify that the plug-in should determine the authentication method to use. It also specifies that cleartext is an acceptable authentication method.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeNodeNativeNoClearText

      kODAuthenticationTypeNodeNativeNoClearText

      The authentication type used to specify that the plug-in should determine the authentication method to use. It also specifies that cleartext is not an acceptable authentication method.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeReadSecureHash

      kODAuthenticationTypeReadSecureHash

      The authentication type used to access the SHA1 or seeded SHA1 hash for a local user.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSMBNTv2UserSessionKey

      kODAuthenticationTypeSMBNTv2UserSessionKey

      The authentication type used to generate an NTLMv2 user session key.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSMBWorkstationCredentialSessionKey

      kODAuthenticationTypeSMBWorkstationCredentialSessionKey

      The authentication type used to generate an SMB workstation credential session key.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSMB_LM_Key

      kODAuthenticationTypeSMB_LM_Key

      The authentication type used to specify SMB LAN manager authentication.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSMB_NT_Key

      kODAuthenticationTypeSMB_NT_Key

      The authentication type used to specify SMB NT authentication.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSMB_NT_UserSessionKey

      kODAuthenticationTypeSMB_NT_UserSessionKey

      The authentication type used by Samba to access session keys on an Apple password server.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSMB_NT_WithUserSessionKey

      kODAuthenticationTypeSMB_NT_WithUserSessionKey

      The authentication type used by Samba to authenticate and access session keys on an Apple password server.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSecureHash

      kODAuthenticationTypeSecureHash

      The authentication type used to specify secure hash authentication.

      Available in OS X v10.6 and later.

      Deprecated in OS X v10.7.

    • kODAuthenticationTypeSetGlobalPolicy

      kODAuthenticationTypeSetGlobalPolicy

      The authentication type used to set the global authentication policy.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSetLMHash

      kODAuthenticationTypeSetLMHash

      The authentication type used to set the LAN manager hash for an account.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSetNTHash

      kODAuthenticationTypeSetNTHash

      The authentication type used to set the NT hash for a user.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSetPassword

      kODAuthenticationTypeSetPassword

      The authentication type used to set a password.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSetPasswordAsCurrent

      kODAuthenticationTypeSetPasswordAsCurrent

      The authentication type used to set a password using the current credentials.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSetPolicy

      kODAuthenticationTypeSetPolicy

      The authentication type used to specify that the plug-in should determine the authentication method to use.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSetPolicyAsCurrent

      kODAuthenticationTypeSetPolicyAsCurrent

      The authentication type used to set the authentication policy using the current credentials.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSetUserData

      kODAuthenticationTypeSetUserData

      The authentication type used to set user data on an Apple password server.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSetUserName

      kODAuthenticationTypeSetUserName

      The authentication type used to set a username on an Apple password server.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSetWorkstationPassword

      kODAuthenticationTypeSetWorkstationPassword

      An authentication type used to support PDC SMB interaction with Directory Services.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeWithAuthorizationRef

      kODAuthenticationTypeWithAuthorizationRef

      The authentication type used to allow root access to local directories with valid authorization.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeWriteSecureHash

      kODAuthenticationTypeWriteSecureHash

      The authentication type used to enable a root process to write the secure hash of a user record.

      Available in OS X v10.6 and later.

    • kODAuthenticationTypeSetCertificateHashAsCurrent

      kODAuthenticationTypeSetCertificateHashAsCurrent

      An authentication type to set the certificate using the authenticated user's credentials.

      The authentication array contains the following items (in order):

      • The username in UTF-8 format

      • Hashed certificate data (40 hex digits)

      Available in OS X v10.7 and later.