User avatar

Table of Contents

Requests
Retrieving user avatar
Uploading user avatar image
Deleting a user’s avatar image

Requests

HTTP verb Endpoint Description

HTTP verb	Endpoint	Description
`GET`	`/rest/v1/iam/users/<id>/avatar`	Retrieving user avatar
`PUT`	`/rest/v1/iam/users/<id>/avatar`	Uploading user avatar image
`DELETE`	`/rest/v1/iam/users/<id>/avatar`	Deleting a user’s avatar image

GET

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

Retrieving user avatar

PUT

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

Uploading user avatar image

DELETE

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

Deleting a user’s avatar image

For all requests:
Domain Type: any

Retrieving user avatar

Returns the user’s avatar image.

If the '&attachment=true' parameter is added to the request URL, the file is downloaded as an attachment. Otherwise, the file is returned with the content type corresponding to the file extension.

Avatar information and image metadata are present in user account in the field 'opts.avatar_info'.
It’s available in API /rest/v1/iam/users.

Request

Request example

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

Response

Example of a successful response

HTTP/1.1 200 OK

binary content of avatar

Example of an unsuccessful response

HTTP/1.1 404 Not Found

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

Uploading user avatar image

Allows you to upload an image file to be used as the user’s avatar.

On successful upload, meta information about the file is put in user account (field 'opts.avatar_info').

Files up to 200 KB in size are allowed for uploading.

Request

Request example

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

Response

Example of a successful response

HTTP/1.1 204 No Content

Example of an unsuccessful response

HTTP/1.1 413 Request Entity Too Large

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

Deleting a user’s avatar image

Allows you to delete the image file used as the user’s avatar.

The meta-information about the file in user account is replaced with a value of 'false'.

Request

Request example

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

Response

Example of a successful response

HTTP/1.1 204 No Content

Example of an unsuccessful response

HTTP/1.1 404 Not Found

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