This resource represents avatars associated with a project. Use it to get, load, set, and remove project avatars.
Sets the avatar displayed for a project.
Use Load project avatar to store avatars against the project, before using this operation to set the displayed avatar.
Permissions required: Administer projects project permission.
manage:jira-projectwrite:project.avatar:jiraConnect app scope required: PROJECT_ADMIN
string
Requiredstring
Requiredany
Returned if the request is successful.
any
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"id": "10010"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/project/{projectIdOrKey}/avatar`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Deletes a custom avatar from a project. Note that system avatars cannot be deleted.
Permissions required: Administer projects project permission.
manage:jira-projectdelete:project.avatar:jiraConnect app scope required: PROJECT_ADMIN
string
Requiredinteger
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
10
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/project/{projectIdOrKey}/avatar/{id}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Loads an avatar for a project.
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/project/{projectIdOrKey}/avatar2'
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 Set project avatar to set it as the project's displayed avatar.
Permissions required: Administer projects project permission.
manage:jira-projectwrite:project.avatar:jira, read:avatar:jiraConnect app scope required: PROJECT_ADMIN
string
Requiredinteger
integer
integer
any
Returned if the request is successful.
Details of an avatar.
1
2
3
4
5
6
7
8
9
10
11
12
13
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/project/{projectIdOrKey}/avatar2`, {
method: 'POST',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
{
"id": "1010",
"isDeletable": true,
"isSelected": false,
"isSystemAvatar": false
}Returns all project avatars, grouped by system and custom avatars.
This operation can be accessed anonymously.
Permissions required: Browse projects project permission for the project.
read:jira-workread:project.avatar:jira, read:avatar:jiraConnect app scope required: READ
string
RequiredReturned if request is successful.
List of project avatars.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/3/project/{projectIdOrKey}/avatars`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
"custom": [
{
"id": "1010",
"isDeletable": true,
"isSelected": false,
"isSystemAvatar": false,
"urls": {
"16x16": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10080&avatarType=project",
"24x24": "https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10080&avatarType=project",
"32x32": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10080&avatarType=project",
"48x48": "https://your-domain.atlassian.net/secure/viewavatar?avatarId=10080&avatarType=project"
}
}
],
"system": [
{
"id": "1000",
"isDeletable": false,
"isSelected": false,
"isSystemAvatar": true,
"urls": {
"16x16": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10040&avatarType=project",
"24x24": "https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10040&avatarType=project",
"32x32": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10040&avatarType=project",
"48x48": "https://your-domain.atlassian.net/secure/viewavatar?avatarId=10040&avatarType=project"
}
}
]
}Rate this page: