Module project_avatars_api

Structs

CreateProjectAvatarParams

struct for passing parameters to the method create_project_avatar

DeleteProjectAvatarParams

struct for passing parameters to the method delete_project_avatar

GetAllProjectAvatarsParams

struct for passing parameters to the method get_all_project_avatars

UpdateProjectAvatarParams

struct for passing parameters to the method update_project_avatar

Enums

CreateProjectAvatarError

struct for typed errors of method create_project_avatar

DeleteProjectAvatarError

struct for typed errors of method delete_project_avatar

GetAllProjectAvatarsError

struct for typed errors of method get_all_project_avatars

UpdateProjectAvatarError

struct for typed errors of method update_project_avatar

Functions

create_project_avatar

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.

delete_project_avatar

Deletes a custom avatar from a project. Note that system avatars cannot be deleted. Permissions required: Administer projects project permission.

get_all_project_avatars

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.

update_project_avatar

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.