user_group_permissions.yaml

user_groups:
  root:  # The group includes all available plan and devices
    allowed_plans:
      - null  # Allow all
    forbidden_plans:
      - ":^_"  # All plans with names starting with '_'
    allowed_devices:
      - null  # Allow all
    forbidden_devices:
      - ":^_:?.*"  # All devices with names starting with '_'
    allowed_functions:
      - null  # Allow all
    forbidden_functions:
      - ":^_"  # All functions with names starting with '_'
  primary:  # The group includes beamline staff, includes all or most of the plans and devices
    allowed_plans:
      - ":.*"  # Different way to allow all plans.
    forbidden_plans:
      - null  # Nothing is forbidden
    allowed_devices:
      - ":?.*:depth=5"  # Allow all device and subdevices. Maximum deepth for subdevices is 5.
    forbidden_devices:
      - null  # Nothing is forbidden
    allowed_functions:
      - "function_sleep"  # Explicitly listed name
  test_user:  # Users with limited access capabilities
    allowed_plans:
      - ":^count"  # Use regular expression patterns
      - ":scan$"
    forbidden_plans:
      - ":^adaptive_scan$" # Use regular expression patterns
      - ":^inner_product"
    allowed_devices:
      - ":^det:?.*"  # Use regular expression patterns
      - ":^motor:?.*"
      - ":^sim_bundle_A:?.*"
    forbidden_devices:
      - ":^det[3-5]$:?.*" # Use regular expression patterns
      - ":^motor\\d+$:?.*"
    allowed_functions:
      - ":element$"
      - ":elements$"
      - "function_sleep"
      - "clear_buffer"
    forbidden_functions:
      - ":^_"  # All functions with names starting with '_'