Support for Server products ended Feb. 15, 2024. Learn what this means for you.

Server

Jira Data Center / Reference / REST API

universal_avatar

Operations

GET/api/2/universal_avatar/type/{type}/owner/{owningObjectId}POST/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar DEL/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}POST/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/temp

GET

Get all avatars for a type and owner

Returns a list of all avatars

Request

Path parameters

type

string

Required

owningObjectId

string

Required

Responses

Returns a list of all Jira avatars in JSON format, that are visible to the user.

application/json

AvatarBean

GET/api/2/universal_avatar/type/{type}/owner/{owningObjectId}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/universal_avatar/type/{type}/owner/{owningObjectId}' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

POST

Create avatar from temporary

Creates avatar from temporary

Request

Path parameters

type

string

Required

owningObjectId

string

Required

Request bodyapplication/json

cropperOffsetX

integer

cropperOffsetY

integer

cropperWidth

integer

needsCropping

boolean

url

string

Responses

Returns the created avatar.

application/json

AvatarBean

POST/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

DEL

Delete avatar by ID

Deletes avatar

Request

Path parameters

integer

Required

type

string

Required

owningObjectId

string

Required

Responses

Returns the status of the deletion.

DEL/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}' \
  --user 'email@example.com:<api_token>'

POST

Create temporary avatar using multipart upload

Creates temporary avatar

Request

Path parameters

type

string

Required

owningObjectId

string

Required

Request bodymultipart/form-data

contentType

string

formField

boolean

inputStream

object

name

string

size

integer

value

string

Responses

Returns temporary avatar cropping instructions.

application/json

AvatarCroppingBean

POST/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/temp

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/temp' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'