permissions.api¶
Permissions API
-
permissions.api.add_permission_to_group(group, permission)¶ Add permission to group.
Parameters: - group –
- permission –
Returns:
-
permissions.api.add_permission_to_user(user, permission)¶ Add permission to user.
Parameters: - user_id –
- permission –
Returns:
-
permissions.api.check_if_group_has_perm(group, permission)¶ Check if group has permission.
Parameters: - group –
- permission –
Returns:
-
permissions.api.create_read_perm(title, owner_id)¶ Create read permission.
Parameters: - title –
- owner_id –
Returns:
-
permissions.api.create_write_perm(title, owner_id)¶ Create write permission.
Parameters: - title –
- owner_id –
Returns:
-
permissions.api.delete_permission(permission_id)¶ Delete a permission.
Parameters: permission_id – Return:
-
permissions.api.get_all_workspace_permissions_user_can_read(user)¶ Get a list of permission ids of workspaces that the user has read access.
Parameters: user – Return:
-
permissions.api.get_all_workspace_permissions_user_can_write(user)¶ Get a list of permission ids of workspaces that the user has write access.
Parameters: user – Return:
-
permissions.api.get_by_codename(codename)¶ Get the permission by codename.
Parameters: codename – Returns:
-
permissions.api.get_by_id(permission_id)¶ Get the permission by id.
Parameters: permission_id – Returns:
-
permissions.api.get_permission_label(permission_id)¶ Get the label of a permission.
Parameters: permission_id – Return:
-
permissions.api.remove_permission_to_group(group, permission)¶ Remove permission from group.
Parameters: - group –
- permission –
Returns:
-
permissions.api.remove_permission_to_user(user, permission)¶ Remove permission from user.
Parameters: - user –
- permission –
Returns: