PayloadKit

Active Directory

com.apple.DirectoryService.managed

The payload that configures an Active Directory (AD) domain.

macOS
macOS 10.8+exclusive

Configuration Keys (39)

KeyTypeTitle
HostNamerequired

The Active Directory domain to join.

stringHostName
UserName

The user name of the account for the domain.

stringUserName
Password

The password of the account for the domain.

stringPassword
ClientID

The client's identifier.

stringClient ID
ADOrganizationalUnit

The organizational unit to add the joining computer object to.

stringADOrganizationalUnit
ADCreateMobileAccountAtLoginFlag

If 'true', the system enables the 'ADCreateMobileAccountAtLogin' key.

Default: false

booleanEnable ADCreateMobileAccountAtLogin Flag
ADCreateMobileAccountAtLogin

If 'true', the system creates a mobile account at login.

Depends on: ADCreateMobileAccountAtLoginFlag ∈ [true]

Default: false

booleanCreate mobile account at login
ADWarnUserBeforeCreatingMAFlag

If 'true', the system enables the 'ADWarnUserBeforeCreatingMA' key.

Default: false

booleanEnable ADWarnUserBeforeCreatingMA Flag
ADWarnUserBeforeCreatingMA

If 'true', the system enables the warning before creating the mobile account.

Depends on: ADWarnUserBeforeCreatingMAFlag ∈ [true]

Default: false

booleanRequire confirmation before creating mobile account
ADForceHomeLocalFlag

If 'true', the system enables the 'ADForceHomeLocal' key.

Default: false

booleanEnable ADForceHomeLocal Flag
ADForceHomeLocal

If 'true', the system forces a local home directory.

Depends on: ADForceHomeLocalFlag ∈ [true]

Default: false

booleanForce local home directory on startup disk
ADUseWindowsUNCPathFlag

If 'true', the system enables the 'ADUseWindowsUNCPath' key.

Default: false

booleanEnable ADUseWindowsUNCPath Flag
ADUseWindowsUNCPath

If 'true', the system uses the UNC path from Active Directory to derive the network home location.

Depends on: ADUseWindowsUNCPathFlag ∈ [true]

Default: false

booleanUse UNC path for network home location
ADMountStyle

The network home protocol to use: 'afp' or 'smb'.

Default: "smb"

Range: AFP (afp), SMB (smb)

stringMount Style
ADDefaultUserShellFlag

If 'true', the system enables the 'ADDefaultUserShell' key.

Default: false

booleanEnable ADDefaultUserShell Key
ADDefaultUserShell

The default user shell.

Depends on: ADDefaultUserShellFlag ∈ [true]

Default: "/bin/bash"

stringDefault user shell
ADMapUIDAttributeFlag

If 'true', the system enables the 'ADMapUIDAttribute' key.

Default: false

booleanEnable ADMapUIDAttribute Key
ADMapUIDAttribute

The map UID to attribute.

Depends on: ADMapUIDAttributeFlag ∈ [true]

stringMap UID to attribute
ADMapGIDAttributeFlag

If 'true', the system enables the 'ADMapGIDAttribute' key.

Default: false

booleanEnable ADMapGIDAttribute Key
ADMapGIDAttribute

The map GID to attribute.

Depends on: ADMapGIDAttributeFlag ∈ [true]

stringMap user GID to attribute
ADMapGGIDAttributeFlag

If 'true', the system enables the 'ADMapGGIDAttributeFlag' key.

Default: false

booleanEnable ADMapGGIDAttribute Key
ADMapGGIDAttribute

The map group GID to attribute.

Depends on: ADMapGGIDAttributeFlag ∈ [true]

stringMap group GID to attribute
ADPreferredDCServerFlag

If 'true', the system enables the 'ADPreferredDCServer' key.

Default: false

booleanEnable ADPreferredDCServer Key
ADPreferredDCServer

The preferred domain server.

Depends on: ADPreferredDCServerFlag ∈ [true]

stringPreferred domain server
ADDomainAdminGroupListFlag

If 'true', the system enables the 'ADDomainAdminGroupList' key.

Default: false

booleanEnable ADDomainAdminGroupList Key
ADDomainAdminGroupList

The list of Active Directory groups with admin access.

Depends on: ADDomainAdminGroupListFlag ∈ [true]

arrayAllow administration by specified Active Directory groups.
ADAllowMultiDomainAuthFlag

If 'true', the system enables the 'ADAllowMultiDomainAuth' key.

Default: false

booleanEnable ADAllowMultiDomainAuth Key
ADAllowMultiDomainAuth

If 'true', the system allows authentication from any domain in the namespace.

Depends on: ADAllowMultiDomainAuthFlag ∈ [true]

Default: false

booleanAllow authentication from any domain in the forest
ADNamespaceFlag

If 'true', the system enables the 'ADNamespace' key.

Default: false

booleanEnable ADNamespace Key
ADNamespace

The primary user account naming convention; either 'forest' or 'domain'.

Depends on: ADNamespaceFlag ∈ [true]

Default: "domain"

Range: domain, forest

stringSet primary user account naming convention: "forest" or "domain"
ADPacketSignFlag

If 'true', the system enables the 'ADPacketSign' key.

Default: false

booleanEnable ADPacketSign Key
ADPacketSign

The packet signing policy.

Depends on: ADPacketSignFlag ∈ [true]

Default: "allow"

Range: allow, disable, require

stringPacket signing
ADPacketEncryptFlag

If 'true', the system enables the 'ADPacketEncrypt' key.

Default: false

booleanEnable ADPacketEncrypt Key
ADPacketEncrypt

The packet encryption policy.

Depends on: ADPacketEncryptFlag ∈ [true]

Default: "allow"

Range: allow, disable, require, ssl

stringPacket encryption
ADRestrictDDNSFlag

If 'true', the system enables the 'ADRestrictDDNS' key.

Default: false

booleanEnable ADRestrictDDNS Key
ADRestrictDDNS

An array of strings that represent the interfaces allowed for dynamic DNS updates, such as en0 and en1.

Depends on: ADRestrictDDNSFlag ∈ [true]

arrayRestrict DDNS on interfaces
ADTrustChangePassIntervalDaysFlag

If 'true', the system enables the 'ADTrustChangePassIntervalDays' key.

Default: false

booleanEnable ADTrustChangePassIntervalDays Key
ADTrustChangePassIntervalDays

The number of days before requiring a change of the computer trust account password. Set to '0' to disable the feature.

Depends on: ADTrustChangePassIntervalDaysFlag ∈ [true]

Default: 14

integerPassword trust interval
Description

The directory service description.

stringDescription
ADDomainAdminGroupListItemrequired

An active directory group

stringDomain Admin Group Item
ADRestrictDDNSItemrequired

An interface name which is allowed to make DDNS updates

stringAllowed DDNS Interface Item