Load avatar

POST

/rest/api/3/universal_avatar/type/{type}/owner/{entityId}

Loads a custom avatar for a project or issue type.

Specify the avatar's local file location in the body of the request. Also, include the following headers:

X-Atlassian-Token: no-check To prevent XSRF protection blocking the request, for more information see Special Headers.

Content-Type: image/image type Valid image types are JPEG, GIF, or PNG.

For example:
curl --request POST

--user email@example.com:<api_token>

--header 'X-Atlassian-Token: no-check'

--header 'Content-Type: image/< image_type>'

--data-binary "<@/path/to/file/with/your/avatar>"

--url 'https://your-domain.atlassian.net/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'

The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.

The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.

After creating the avatar use:

Update issue type to set it as the issue type's displayed avatar.

Set project avatar to set it as the project's displayed avatar.

Permissions required: Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/universal_avatar/type//owner/?size=' \
--header 'Content-Type: text/plain' \
--data-raw ''

Response Example

201 - Success

{"id":"1000","isSystemAvatar":true,"isSelected":false,"isDeletable":false,"urls":{"16x16":"/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project","24x24":"/secure/useravatar?size=small&avatarId=10040&avatarType=project","32x32":"/secure/useravatar?size=medium&avatarId=10040&avatarType=project","48x48":"/secure/useravatar?avatarId=10040&avatarType=project"}}

Request

Path Params

type

string

required

The avatar type.

entityId

string

required

The ID of the item the avatar is associated with.

Query Params

integer

optional

The X coordinate of the top-left corner of the crop region.

integer

optional

The Y coordinate of the top-left corner of the crop region.

size

integer

required

The length of each side of the crop region.

Responses

🟢201Returned if the request is successful.

application/json

Body

Details of an avatar.

fileName

string

read-onlyoptional

The file name of the avatar icon. Returned for system avatars.

string

required

The ID of the avatar.

isDeletable

boolean

read-onlyoptional

Whether the avatar can be deleted.

isSelected

boolean

read-onlyoptional

Whether the avatar is used in Jira. For example, shown as a project's avatar.

isSystemAvatar

boolean

read-onlyoptional

Whether the avatar is a system avatar.

owner

string

read-onlyoptional

The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.

urls

object

read-onlyoptional

The list of avatar icon URLs.

Additional properties

string <uri>

read-onlyoptional

Additional properties

integer | number | string | boolean

optional

🟠400Returned if: * an image isn't included in the request. * the image type is unsupported. * the crop parameters extend the crop area beyond the edge of the image.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have the necessary permissions.

🟠404Returned if the avatar type is invalid, the associated item ID is missing, or the item is not found.

Modified at 2023-07-13 03:27:27

Get avatars

Delete avatar