Account API
Endpoints Account работают с текущим пользователем, его метаданными, аватаром и выбранным workspace.
Все endpoints требуют Authorization: Bearer <token>, кроме случаев, когда токен создается после внешнего процесса авторизации.
POST /api/v1/token
Создает или возвращает API-токен для авторизованной identity.
Аргументы: path/query аргументов нет.
Тело запроса:
| Поле | Обязательное | Описание |
|---|---|---|
app | Да | Имя auth app/provider. |
credentials | Да | Учетные данные выбранного provider. |
Ответ: TokenResponse.
GET /api/v1/me
Возвращает текущий account, identity, tier, memberships и выбранный workspace.
Аргументы: нет.
Тело запроса: нет.
Ответ: Me.
DELETE /api/v1/me
Удаляет текущий account.
Аргументы: нет.
Тело запроса: нет.
Ответ: OperationResult.
PUT /api/v1/me/meta
Обновляет пользовательские метаданные.
Аргументы: нет.
Тело запроса:
| Поле | Обязательное | Описание |
|---|---|---|
nickname | Нет | Отображаемое имя пользователя, 2-80 символов. |
Ответ: Me.
POST /api/v1/me/avatar
Загружает avatar текущего account.
Аргументы: нет.
Тело запроса:
| Поле | Обязательное | Описание |
|---|---|---|
filename | Да | Исходное имя файла. |
contentType | Да | MIME-тип изображения. |
data | Да | Данные изображения в Base64. |
Ответ: AvatarUploadResult.
GET /api/v1/me/workspace
Возвращает выбранный workspace текущего account.
Аргументы: нет.
Тело запроса: нет.
Ответ: CurrentWorkspaceResponse.
POST /api/v1/me/workspace
Меняет выбранный workspace текущего account.
Аргументы: нет.
Тело запроса:
| Поле | Обязательное | Описание |
|---|---|---|
workspace | Да | Workspace fullname или null, чтобы сбросить выбор. |
Ответ: CurrentWorkspaceResponse.
GET /api/v1/account/settings
Возвращает account settings.
Аргументы: нет.
Тело запроса: нет.
Ответ: AccountSettings.
POST /api/v1/account/settings
Сохраняет account settings.
Аргументы: нет.
Тело запроса: объект settings. Конкретный набор полей зависит от текущей версии account settings UI.
Ответ: AccountSettings.