Новый API доступа к папкам BIM 360
Новый Folder Permission API позволяет устанавливать/редактировать/удалять настраивать доступ пользователей/ролей/компаний к папкам так же, как это осуществляется с помощью пользовательского интерфейса. API включает следующие методы:
- Create Permissions POST projects/:project_id/folders/:folder_id/permissions:batch-create
- GET Permissions GET projects/:project_id/folders/:folder_id/permissions
- Update Permissions POST projects/:project_id/folders/:folder_id/permissions:batch-update
- Delete Permissions POST projects/:project_id/folders/:folder_id/permissions:batch-delete
Вы можете использовать эти API для редактирования доступа к папке одного или нескольких пользователей/ролей/компаний.
Отметим ряд моментов:
- Важно понимать, как задаются и работают настройки доступа в пользовательском интерфейсе BIM 360 перед тем, как использовать новый API. Пользовательский доступ может являться комбинацией нескольких настроек. Он может наследоваться от родительской папки, группы (компании/роли) или задаваться для конкретного пользователя. Например, настройки доступа для пользователя могут переопределять настройки в родительской папке. Детальное описание доступно здесь.
- Следующий список из 6 уровней доступа в пользовательском интерфейсе и соответствующие «действия» в API:
- UI:View Only, API: VIEW, COLLABORATE
- UI:View/Download, API: VIEW, DOWNLOAD, COLLABORATE
- UI:Upload Only, API: PUBLISH
- UI:View/Download+Upload, API: PUBLISH, VIEW, DOWNLOAD, COLLABORATE
- UI:View/Download+Upload+Edit, API: PUBLISH, VIEW, DOWNLOAD, COLLABORATE, EDIT
- UI:Folder Control, API: PUBLISH, VIEW, DOWNLOAD, COLLABORATE, EDIT, CONTROL
- Permission API может работать с папками Plans, Project Files и их подпапками. Он не может изменить коренную папку проекта.
- Project Admin имеет полный доступ к папкам по умолчанию.
- Поддерживается 3-legged и 2-legged авторизация. В случае 2-legged можно указать “x-user-id” в заголовке, чтобы работать от имени конкретного пользователяThese APIs
- Это API вводит новую терминологию - subjectId, которое соответствует уникальным идентификаторам для пользователя/роли/компании, используемых в BIM 360 Admin API.
Руководство получения настроек доступа пользователя к папке показывает, как получить полные настройки доступа пользователя к одной папке. В нём используется метод GET projects/users/:id для получения ролей/компаний пользователя.
Руководство изменения настроек доступа к папке для пользователя показывает, как обновить настройки доступа к папке для конкретного пользователя.
Источник: https://forge.autodesk.com/blog/folder-permission-api-bim-360-released
Опубликовано 29.04.2020