OpenDirectory queries and manages directory services on macOS, letting you look up and modify users, groups, and other records used for authentication and identity. You begin with an ODSession and open an ODNode that represents a directory domain, then run an ODQuery to retrieve ODRecord objects or read and update their attributes. Configuration types such as ODConfiguration, ODMappings, ODAttributeMap, and ODModuleEntry describe how a node maps and resolves directory data, while ODQueryDelegate delivers query results and ODFrameworkErrors reports failures.
Sessions and Nodes 4
Establish a connection to directory services and open the node that represents a directory domain.
- ClODSession@class ODSession
- ClODNode@class ODNode
- ClODSessionRef@typedef ODSessionRef
- ClODNodeRef@typedef ODNodeRef
Querying Records 3
Search a node for matching records and receive results as they arrive.
- ClODQuery@class ODQuery
- PrODQueryDelegate@protocol ODQueryDelegate
- ClODQueryRef@typedef ODQueryRef
Records and Attributes 2
Read and modify the user, group, and other directory records and their attributes.
- ClODRecord@class ODRecord
- ClODRecordRef@typedef ODRecordRef
Directory Configuration 5
Describe how a node maps and resolves directory data through configuration and attribute mappings.
- ClODConfigurationmacOS 10.9+An object that describes how a directory node maps and resolves the records it serves.
- ClODMappingsmacOS 10.9+An object that groups the record and attribute mappings used to resolve a node's directory data.
- ClODAttributeMapmacOS 10.9+An object that describes how a directory attribute maps to and resolves from a node's underlying data.
- ClODRecordMapmacOS 10.9+An object that describes how a record type maps to and resolves from a node's underlying data.
- ClODModuleEntrymacOS 10.9+An object that describes a directory module participating in a node's configuration.
Authentication Context 2
Maintain state across multi-step authentication and credential operations.
- ClODContextAn object that maintains state across a multi-step authentication or credential operation.
- ClODContextRef@typedef ODContextRef
Errors 1
Identify failures reported by Open Directory operations.
- StODFrameworkErrors@enum ODFrameworkErrors
Type Aliases 15
- TyODQueryCallback@typedef ODQueryCallback
- TyODNodeType
- TyODMatchType
- TyODRecordType
- TyODAttributeType
- TyODAuthenticationType
- TyODPolicyType
- TyODErrorUserInfoKeyType
- TyODOptionKeyType
- Ty_ODRecordType
- Ty_ODAttributeType
- Ty_ODAuthenticationType
- TyODPolicyKeyType
- TyODPolicyCategoryType
- TyODPolicyAttributeType