Аватар пользователя

Содержание

Запросы
Получение аватарки пользователя
Загрузка изображения-аватара пользователя
Удаление изображения-аватара пользователя

Запросы

HTTP verb Endpoint Описание

HTTP verb	Endpoint	Описание
`GET`	`/rest/v1/iam/users/<id>/avatar`	Получение аватарки пользователя
`PUT`	`/rest/v1/iam/users/<id>/avatar`	Загрузка изображения-аватара пользователя
`DELETE`	`/rest/v1/iam/users/<id>/avatar`	Удаление изображения-аватара пользователя

GET

/rest/v1/iam/users/<id>/avatar

Получение аватарки пользователя

PUT

/rest/v1/iam/users/<id>/avatar

Загрузка изображения-аватара пользователя

DELETE

/rest/v1/iam/users/<id>/avatar

Удаление изображения-аватара пользователя

Для всех запросов:
Тип домена: любой

Получение аватарки пользователя

Возвращает изображение-аватар пользователя.

Если в URL запроса добавить параметр '&attachment=true', то файл скачивается вложением. Иначе файл возвращается с типом контента, соответствующим расширению файла.

Информация о наличии аватара и метаданные изображения присутствуют в учетной записи пользователя в поле 'opts.avatar_info'.
Она доступна в API /rest/v1/iam/users.

Запрос

Пример запроса

GET /rest/v1/iam/users/7b2130e5-3302-a826-104c-1a8273b2093f/avatar HTTP/1.1

Ответ

Пример успешного ответа

HTTP/1.1 200 OK

binary content of avatar

Пример неудачного ответа

HTTP/1.1 404 Not Found

{
  "error_code": 1404,
  "error_message": "Avatar not found"
}

Загрузка изображения-аватара пользователя

Позволяет загрузить файл с изображением, используемый в качестве аватарки пользователя.

При успешной загрузке в учетную запись пользователя (поле 'opts.avatar_info') проставляется мета-информация о файле.

К загрузке разрешены файлы размером до 200 КБ.

Запрос

Пример запроса

PUT /rest/v1/iam/users/7b2130e5-3302-a826-104c-1a8273b2093f/avatar HTTP/1.1
Content-Type: multipart/form-data
Content-Disposition: form-data; name="asdf"; filename="image.png"

multipart content

Ответ

Пример успешного ответа

HTTP/1.1 204 No Content

Пример неудачного ответа

HTTP/1.1 413 Request Entity Too Large

{
  "error_code": 1506,
  "error_message":"upload exceeds maximum size of 204800"
}

Удаление изображения-аватара пользователя

Позволяет удалить файл с изображением, используемый в качестве аватарки пользователя.

Мета-информация о файле в учетной записи пользователя заменяется значением 'false'.

Запрос

Пример запроса

DELETE /rest/v1/iam/users/7b2130e5-3302-a826-104c-1a8273b2093f/avatar HTTP/1.1

Ответ

Пример успешного ответа

HTTP/1.1 204 No Content

Пример неудачного ответа

HTTP/1.1 404 Not Found

{
  "error_code": 1404,
  "error_message": "Avatar not found"
}