apple_device-management/declarative/status/management.declarations.yaml

title: Status Management Declarations
description: The status item that reports the device's processed declarations.
payload:
  statusitemtype: management.declarations
  supportedOS:
    iOS:
      introduced: '15.0'
      allowed-enrollments:
      - supervised
      - device
      - user
      allowed-scopes:
      - system
      sharedipad:
        allowed-scopes:
        - system
        - user
    macOS:
      introduced: '13.0'
      allowed-enrollments:
      - supervised
      - user
      allowed-scopes:
      - system
      - user
    tvOS:
      introduced: '16.0'
      allowed-enrollments:
      - supervised
      - device
      allowed-scopes:
      - system
    visionOS:
      introduced: '1.1'
      allowed-enrollments:
      - supervised
      - device
      - user
      allowed-scopes:
      - system
    watchOS:
      introduced: '10.0'
      allowed-enrollments:
      - supervised
      allowed-scopes:
      - system
payloadkeys:
- key: management.declarations
  title: Status item value.
  type: <dictionary>
  presence: required
  content: A collection of the client's processed declarations.
  subkeytype: Declarations
  subkeys:
  - key: activations
    title: Activations
    type: <array>
    presence: required
    content: An array of declarations that represent the client's processed activation
      types.
    subkeytype: Declaration
    subkeys:
    - key: _activations
      title: Status declaration item
      type: <dictionary>
      content: Status for a declaration processed by the client.
      subkeytype: Declaration
      subkeys: &id001
      - key: identifier
        title: Identifier
        type: <string>
        presence: required
        content: The `identifier` of the declaration this status report refers to.
      - key: server-token
        title: Server-token
        type: <string>
        presence: required
        content: The `ServerToken` of the declaration this status report refers to.
      - key: active
        title: Declaration's active state
        type: <boolean>
        presence: required
        content: If `true`, the declaration is active on the device.
      - key: valid
        title: Declaration's valid state
        type: <string>
        presence: required
        rangelist:
        - unknown
        - invalid
        - valid
        content: This string defines the validity of the declaration. If it's `invalid`,
          the `reasons` property contains more details.
      - key: reasons
        title: Status reasons
        type: <array>
        presence: optional
        content: The details of any client errors.
        subkeytype: StatusReason
        subkeys:
        - key: _reasons
          title: Status reason
          type: <dictionary>
          content: Information about a status error.
          subkeytype: StatusReason
          subkeys:
          - key: code
            title: Error code
            type: <string>
            presence: required
            content: The error code for this error.
          - key: description
            title: Error description
            type: <string>
            presence: optional
            content: The description for this error.
          - key: details
            title: Error details
            type: <dictionary>
            presence: optional
            content: A dictionary that contains further details about this error.
            subkeys:
            - key: ANY
              type: <any>
              presence: optional
              content: Additional keys may be present.
  - key: configurations
    title: Configurations
    type: <array>
    presence: required
    content: An array of declarations that represent the client's processed configuration
      types.
    subkeytype: Declaration
    subkeys:
    - key: _configurations
      title: Status declaration item
      type: <dictionary>
      content: Status for a declaration processed by the client.
      subkeytype: Declaration
      subkeys: *id001
  - key: assets
    title: Assets
    type: <array>
    presence: required
    content: An array of declarations that represent the client's processed assets.
    subkeytype: Declaration
    subkeys:
    - key: _assets
      title: Status declaration item
      type: <dictionary>
      content: Status for a declaration processed by the client.
      subkeytype: Declaration
      subkeys: *id001
  - key: management
    title: Management
    type: <array>
    presence: required
    content: An array of declarations that represent the client's processed declaration
      types.
    subkeytype: Declaration
    subkeys:
    - key: _management
      title: Status declaration item
      type: <dictionary>
      content: Status for a declaration processed by the client.
      subkeytype: Declaration
      subkeys: *id001
notes:
- title: ''
  content: The name of the declaration status item is `management.declarations`.
examples:
- title: Status item example
  files:
  - file: data/docc-examples/remotemanagementmodel/status/management.declarations/example1.json