The accessiblefields.yaml files

An accessiblefields.yaml file is a file that lists the fields a user can access when an additional accessible fields filter grants them filtered access to a resource. All accessiblefields.yaml files are stored in the integration > roles > additionalaccessiblefieldsfilters directory. They all have names that end in "accessiblefields.yaml".

Each file contains an accessibleFields section with a list of resource types. For each type, there is an edit and view section. Each section lists the fields that a user can edit or view when restricted by the filter. If a user cannot edit or view any fields, then the section lists "[]".

For example, the following is a portion of the accountprimarypayer.accessiblefields.yaml file.
name: accountprimarypayer
accessibleFields:
 AccountContact:
   edit: []
   view:
   - displayName
   - id
   - primaryPayer
   - roles
 ...

For a given user and AccountContact, if the user is restricted to the accountprimarypayer accessible fields filter, then:

  • The user cannot edit any fields.

  • The user can view only the displayName, id, primaryPayer, and roles fields.