jira.js
    Preparing search index...

    Function storeAvatar

    • Loads a custom avatar for a project, issue type or priority.

      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:

      Permissions required: Administer Jira global permission.

      Parameters

      • client: Client
      • parameters: {
            body: Blob;
            entityId: string;
            size: number;
            type: "priority" | string & {} | "project" | "issuetype";
            x?: number;
            y?: number;
        }
        • body: Blob
        • entityId: string

          The ID of the item the avatar is associated with.

        • size: number

          The length of each side of the crop region.

        • type: "priority" | string & {} | "project" | "issuetype"

          The avatar type.

        • Optionalx?: number

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

        • Optionaly?: number

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

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              fileName?: string;
              id: string;
              isDeletable?: boolean;
              isSelected?: boolean;
              isSystemAvatar?: boolean;
              owner?: string;
              urls?: Record<string, any>;
              [key: string]: unknown;
          },
      >