Проекты
Граница тенанта платформы ForestVPN — создание, участники и роли, приглашения, передача владения и журнал аудита.
Проект — это граница изоляции, внутри которой существует всё остальное: потребители, устройства, API-ключи, биллинг и история аудита привязаны ровно к одному проекту. Ничто не пересекает эту границу — учётные данные одного проекта не могут читать другой.
Создание и список проектов
Семейство /platform/v1/projects покрывает весь жизненный цикл:
| Операция | Эндпоинт |
|---|---|
| Список проектов, в которых вы состоите | GET /platform/v1/projects |
| Создать проект | POST /platform/v1/projects |
| Прочитать один проект | GET /platform/v1/projects/{project_id} |
| Удалить проект | DELETE /platform/v1/projects/{project_id} |
| Передать владение | POST /platform/v1/projects/{project_id}/transfer |
После создания UUID проекта — это то, что вы отправляете в X-Project-Id при
каждом вызове /platform/v1, и то, к чему привязаны ваши
API-ключи.
Участники и роли
У проекта есть участники-люди, у каждого — роль, определяющая, что ему доступно:
owner— полный контроль, включая удаление и передачу владенияadmin— повседневное управлениеmember— обычный участникviewer— только чтение
Биллинговые полномочия — это вторая, независимая ось (owner /
billing_admin / billing_viewer), чтобы доступ к финансам не был обязан
следовать за инженерным доступом. Управляйте обеими осями под
/platform/v1/projects/{project_id}/members — GET для списка участников,
PATCH …/members/{user_id}/role для смены роли,
PATCH …/members/{user_id}/billing-scope для настройки биллинговой оси и
DELETE …/members/{user_id}, чтобы удалить участника.
Новые люди присоединяются по приглашению: создайте его через
POST /platform/v1/projects/{project_id}/invites; приглашённый принимает
ссылку с токеном и попадает в проект с той ролью, которая указана в
приглашении.
Журнал аудита
Каждое административное действие в проекте — выпуск и отзыв ключей, смена
ролей, биллинговые операции — записывается и доступно для запроса по
GET /platform/v1/projects/{project_id}/audit-log. Записи несут актора,
субъект и снимки «до/после» там, где они применимы, поэтому вы можете
ответить на вопрос «кто это изменил и когда», не заводя тикет.
Справочник
Полные формы запросов и ответов для каждой операции выше — в сгенерированном справочнике API в разделах projects, members и invites.
API-ключи
Выпустите привязанный к проекту API-ключ fvpn_v1_ в консоли, сделайте первый аутентифицированный вызов /platform/v1 и управляйте жизненным циклом ключа.
Потребители
Ваши конечные пользователи на платформе ForestVPN — потребительские аккаунты, аутентификация устройств, сессии и строгая изоляция по проектам.