CLI Reference

Managing Resources

ls

The fides ls command gets a list of all resources from the server and displays them as YAML.

Usage

Usage: fides ls [args]

The command will list all of the remote resources of the specified type from the Server.

Accepted argument types for this command are:

• data_category: a specific category from the taxonomy. A valid example would be user.name.
• data_qualifier: a specific qualifier from the taxonomy. A valid example would be aggregated.
• data_subject: a specific data subject from the taxonomy. A valid example is customer.
• data_use: a specific use of data from the taxonomy. A valid example is advertising.third_party.
• dataset: a dataset that represents a collection of information in a system such as the collection of tables in a postgres database.
• evaluation: the result of a policy evaluation check.
• organization: the name of the organization defined in Fides.
• policy: a Fides policy rule.
• system: a specific system resource.

Example: List all data_category resources from the server

This example lists all data_category resources from the server and displays them as YAML.

$ fides ls data_category
Loaded config from: .fides/fides.toml
----------
data_category:
- description: Data related to the user of the system, either provided directly or
    derived based on their usage.
  fides_key: user
  is_default: true
  name: User Data
  organization_fides_key: default_organization
  parent_key: null
  tags: null
- description: Contact data collected about a user.
  fides_key: user.contact
  is_default: true
  name: Contact Data
  organization_fides_key: default_organization
  parent_key: user
  tags: null
- description: Contact address data collected about a user.
  fides_key: user.contact.address
  is_default: true
  name: Contact Data
  organization_fides_key: default_organization
  parent_key: user.contact
  tags: null
- all data categories, etc...