Endpoint configuration · GraphQL query

userSystemSettings query

Retrieves one macOS user's UserSystemSettings by its graph object id: screen saver locking, Universal Control, Siri and search data sharing, Bluetooth sharing, the location daemon preference, and whether a password hint is set. One exists per user account on each macOS endpoint, reachable through that EndpointUser's userSystemSettings field; machine-wide settings are on SystemSettings. Find them across endpoints with graphSearch on the USER_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 UserSystemSettingsPayload!

Arguments

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

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

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

Example

Query

query userSystemSettings(
  $id: ID!,
  $mockOptions: MockDataInput
) {
  userSystemSettings(
    id: $id,
    mockOptions: $mockOptions
  ) {
    node {
      id
      orgId
      objectType
      objectTypeLabel
      displayName
      firstSeen
      lastSeen
      seen {
        ...SeenOnlineFragment
      }
      createdAt
      updatedAt
      snapshotInfo {
        ...GraphObjectSnapshotInfoFragment
      }
      endpointUser {
        ...EndpointUserFragment
      }
      osSpecific {
        ... on UserSystemSettingsMacOS {
          ...UserSystemSettingsMacOSFragment
        }
      }
      findings {
        ...FindingsPayloadFragment
      }
      issues {
        ...IssuesPayloadFragment
      }
      issuesSummary {
        ...IssuesSummaryFragment
      }
    }
  }
}

Variables

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

Response

{
  "data": {
    "userSystemSettings": {"node": UserSystemSettings}
  }
}