API role files

API roles are defined in YAML files that are named RoleName.role.yaml. For example:

Location of API role files

API roles are declared in Studio in the Integration > roles directory. When checking for role files, Cloud API looks in this directory only (and not in any subdirectories of the roles directory).

Note: In most cases when an insurer adds files to an instance of InsuranceSuite application, the best practice is to add these files to a subdirectory that is named after the insurer. However, an insurer cannot follow this practice with role files. For a role file to be available to Cloud API, the file must be declared directly in the roles directory. It cannot be declared in a subdirectory.

Structure of API role files

API roles are declared in Studio in the Integration > roles directory. Every file identifies:

  • The role name
  • The role's applicable orbits (or planet classes)
  • The endpoints and endpoint operations for associated users
  • The fields that associated users can view or edit
  • Any special permission granted to associated callers

Note that these parts can be listed in any order.