mirror of
https://github.com/apple/device-management.git
synced 2026-08-14 20:40:19 +02:00
114 lines
3.3 KiB
YAML
114 lines
3.3 KiB
YAML
title: Account:LDAP
|
|
description: The declaration to configure a Lightweight Directory Access Protocol
|
|
(LDAP) account.
|
|
payload:
|
|
declarationtype: com.apple.configuration.account.ldap
|
|
supportedOS:
|
|
iOS:
|
|
introduced: '15.0'
|
|
allowed-enrollments:
|
|
- supervised
|
|
- device
|
|
- user
|
|
- local
|
|
allowed-scopes:
|
|
- system
|
|
sharedipad:
|
|
allowed-scopes:
|
|
- user
|
|
macOS:
|
|
introduced: '13.0'
|
|
allowed-enrollments:
|
|
- supervised
|
|
- user
|
|
- local
|
|
allowed-scopes:
|
|
- user
|
|
tvOS:
|
|
introduced: n/a
|
|
visionOS:
|
|
introduced: '1.1'
|
|
allowed-enrollments:
|
|
- supervised
|
|
- device
|
|
- user
|
|
- local
|
|
allowed-scopes:
|
|
- system
|
|
watchOS:
|
|
introduced: n/a
|
|
apply: multiple
|
|
payloadkeys:
|
|
- key: VisibleName
|
|
title: Account name
|
|
type: <string>
|
|
presence: optional
|
|
content: The name that apps show to the user for this LDAP account. If not present,
|
|
the system generates a suitable default.
|
|
- key: HostName
|
|
title: Server host name
|
|
type: <string>
|
|
presence: required
|
|
content: The hostname or IP address of the LDAP server.
|
|
- key: Port
|
|
title: Server port
|
|
type: <integer>
|
|
presence: optional
|
|
content: The port number or IP address of the LDAP server.
|
|
- key: AuthenticationCredentialsAssetReference
|
|
title: Authentication credentials asset reference
|
|
type: <string>
|
|
assettypes:
|
|
- com.apple.asset.credential.userpassword
|
|
presence: optional
|
|
content: The identifier of an asset declaration that contains the credentials for
|
|
this account. Set the corresponding asset type to `CredentialUserNameAndPassword`.
|
|
- key: SearchSettings
|
|
title: Search settings
|
|
type: <array>
|
|
presence: optional
|
|
content: The array of nodes to start LDAP searches from. There must be at least
|
|
one node for this account to be useful. macOS only searches one node and ignores
|
|
other items in the array.
|
|
subkeys:
|
|
- key: SearchSettingsItem
|
|
title: An LDAP search setting
|
|
type: <dictionary>
|
|
subkeys:
|
|
- key: VisibleDescription
|
|
title: Visible description
|
|
type: <string>
|
|
presence: optional
|
|
content: The description of this search setting in the Contacts and Settings
|
|
apps. If not present, the apps display no name.
|
|
- key: SearchBase
|
|
title: Search base
|
|
type: <string>
|
|
presence: required
|
|
content: The path to the node where a search starts. For example, `ou=people,o=example
|
|
corp`.
|
|
- key: Scope
|
|
title: Scope
|
|
type: <string>
|
|
presence: optional
|
|
rangelist:
|
|
- Base
|
|
- OneLevel
|
|
- Subtree
|
|
default: Subtree
|
|
content: |-
|
|
The type of recursion to use in the search:
|
|
|
|
- `Base`: The search uses only the `SearchBase` node.
|
|
- `OneLevel`: The search uses the `SearchBase` node and its immediate children.
|
|
- `Subtree`: The search uses the `SearchBase` node and all its children, regardless of depth.
|
|
related-status-items:
|
|
- status-items:
|
|
- account.list.ldap
|
|
note: Each configuration will have a corresponding status item.
|
|
examples:
|
|
- title: Configuration example
|
|
files:
|
|
- description: This configuration sets up an LDAP directory account.
|
|
file: examples/declarative/declarations/configurations/account.ldap/example1.json
|