Files
apple_device-management/declarative/status/account.list.ldap.yaml
T
2026-06-22 15:55:19 -04:00

106 lines
2.9 KiB
YAML

title: Status Account List LDAP
description: The status item that lists the devices's Lightweight Directory Access
Protocol (LDAP) accounts.
payload:
statusitemtype: account.list.ldap
supportedOS:
iOS:
introduced: '16.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
payloadkeys:
- key: account.list.ldap
title: Status item value.
type: <array>
presence: required
content: A list of status values for the LDAP accounts.
subkeytype: Account
subkeys:
- key: status_value
title: Status value
type: <dictionary>
content: An LDAP account.
subkeys:
- key: identifier
title: Unique identifier of the account.
type: <string>
presence: required
content: The unique identifier for the account.
- key: _removed
title: Indicates removal of the account.
type: <boolean>
presence: optional
default: false
content: If `true`, the device removed the account and the status item object
only contains this key and the `identifier` key.
- key: declaration-identifier
title: Identifier of the declaration that installed the account.
type: <string>
presence: optional
content: The identifier of the declaration that installed the account. Only
present if a declaration installed the account.
- key: visible-name
title: Account name
type: <string>
presence: optional
content: The name of the account.
- key: hostname
title: Account hostname
type: <string>
presence: optional
content: The server host name for the account.
- key: port
title: Server port
type: <integer>
presence: optional
content: The server port for the account.
- key: username
title: Account username
type: <string>
presence: optional
content: The user name for the account.
- key: is-enabled
title: Is account enabled
type: <boolean>
presence: optional
content: A Boolean value that indicates whether the account is enabled for use
with the Contacts app.
examples:
- title: Status item example
files:
- tab: New or updated account
description: Reports a new or updated account.
file: data/docc-examples/remotemanagementmodel/status/account.list.ldap/example1.json
- tab: Removed account
description: Reports a removed account.
file: data/docc-examples/remotemanagementmodel/status/account.list.ldap/example2.json