By default gears can be used by any user sitewide. However, Site Administrators or Site Developers can limit gear access to designated users, projects, or groups. For more information on the impact of gear permissions, see this article.
A site admin or site developer can update the permissions on a specific gear based on the gear name. Permissions are set at the group, project, or user level. Combinations and multiples are allowed. A permission of None will result in giving sitewide permissions, and is the default when a gear is first loaded.
Site Administrators or Gear Developers can set Gear permissions using the following functions in the the Flywheel Python SDK.
In these examples "awesome-gear" is an example gear name. "user@flywheel.io" is an example user id, "623b89fff383de7494a88e66" is an example project id and "research" is an example group id.
1. Checking existing permissions on the gear
fw.get_gear_series("awesome-gear")
2. Assigning “awesome-gear” access to “user@flywheel.io”
fw.replace_gear_permissions("awesome-gear",{"users" : ['user@flywheel.io']})
3. Removing any restrictions on the gear, setting the gear permissions to default(None)
fw.delete_gear_permissions('awesome-gear')
4. Adding another user to the “awesome-gear”
fw.add_gear_permission("awesome-gear", "users", {"id":"user@flywheel.io"})
5. For group level and project level permissions, the same commands apply, but the input becomes:
fw.replace_gear_permission("awesome-gear", "users", {"id":"user@flywheel.io"}, "group", {"id":"research")
6. To remove all permissions and make a gear inaccessible by users, provide empty lists:
fw.replace_gear_permissions(gear_name,{"users" : [], 'projects': [], 'groups':[]})