Endpoint configuration · GraphQL query

systemSettings query

Retrieves a macOS endpoint's SystemSettings by its graph object id: the machine-wide configuration, including System Integrity Protection, Gatekeeper, XProtect, and AMFI state, privacy (TCC) permissions, sudo configuration, lock screen, power, Time Machine backup, and sharing settings. Each macOS Endpoint has at most one, also reachable through its systemSettings field; per-user settings are on UserSystemSettings. Find them across endpoints with graphSearch on the SYSTEM_SETTINGS object type. Returns a not-found error when no object has the id, and an error when the id belongs to another object type.

Response

Returns a SystemSettingsPayload!

Arguments

Name Description
id - ID! The SystemSettings identifier.
mockOptions - MockDataInput

Options for mock data generation. Options supported: key: "PLATFORM", value: OsPlatform

example: "mockOptions": { "options": [ { "key": "PLATFORM", "value": "WINDOWS" } ] }

Example

Query

query systemSettings(
  $id: ID!,
  $mockOptions: MockDataInput
) {
  systemSettings(
    id: $id,
    mockOptions: $mockOptions
  ) {
    node {
      id
      orgId
      seen {
        ...SeenOnlineFragment
      }
      objectType
      objectTypeLabel
      displayName
      firstSeen
      lastSeen
      createdAt
      updatedAt
      snapshotInfo {
        ...GraphObjectSnapshotInfoFragment
      }
      endpoint {
        ...EndpointFragment
      }
      osSpecific {
        ... on SystemSettingsMacOS {
          ...SystemSettingsMacOSFragment
        }
      }
      findings {
        ...FindingsPayloadFragment
      }
      issues {
        ...IssuesPayloadFragment
      }
      issuesSummary {
        ...IssuesSummaryFragment
      }
    }
  }
}

Variables

{"id": 4, "mockOptions": MockDataInput}

Response

{"data": {"systemSettings": {"node": SystemSettings}}}