fleet/schema/tables/filevault_users.yml
Lucas Manuel Rodriguez 4784217b57
Add documentation for missing fleetd tables and regenerate JSON (#9960)
Updating documentation of Fleetd tables as part of the oncall duty.

Updating the json used by Fleet using the following command:
```sh
cd website
 ./node_modules/sails/bin/sails.js run generate-merged-schema
```

Samples:
![Screenshot 2023-02-20 at 17 20
55](https://user-images.githubusercontent.com/2073526/220192112-69a116e4-badb-4328-92d3-9a2a6f8657fe.png)
![Screenshot 2023-02-20 at 17 21
09](https://user-images.githubusercontent.com/2073526/220192117-dfa06c69-2166-47d4-99c3-e108911e2084.png)


@mikermcneil @eashaw: `generate-merged-schema` generates a different
output every time it's executed. Guess: It seems it should sort the
output lexicograhically?
2023-02-22 16:05:36 -03:00

25 lines
1.0 KiB
YAML

name: filevault_users
notes: This table is not a core osquery table. It is included as part of [Fleetd](https://fleetdm.com/docs/using-fleet/orbit), the osquery manager from Fleet. Fleetd can be built with [fleetctl](https://fleetdm.com/docs/using-fleet/adding-hosts#osquery-installer).
description: Information on the users able to unlock the current boot volume if protected with FileVault.
platforms:
- darwin
evented: false
examples: >-
List the usernames able to unlock and boot a computer protected by FileVault, joined to
[users.username](http://fleetdm.com/tables/users) to obtain the description of the operating
system account that owns it.
```
SELECT fu.username, u.description FROM filevault_users fu JOIN users u ON fu.uuid=u.uuid;
```
columns:
- name: username
description: Username of the FileVault user.
required: false
type: text
- name: uuid
description: UUID of the FileVault user, which can be joined to [users.uuid](http://fleetdm.com/tables/users).
required: false
type: text