@itentialopensource/adapter-jira

openapi: 3.0.0 info: title: The Jira Cloud platform REST API description: Jira Cloud platform REST API documentation contact: email: ecosystem@atlassian.com version: '1001.0.0-SNAPSHOT' servers: - url: https://your-domain.atlassian.net variables: {} - url: https://auth.atlassian.com variables: {} paths: /rest/api/3/announcementBanner: get: tags: - Announcement banner summary: getBanner description: >- Returns the current announcement banner configuration. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: getBanner parameters: [] responses: '200': description: Returned if the request is successful. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/AnnouncementBannerConfiguration' - description: Announcement banner configuration. '401': description: Returned if the authentication credentials are incorrect or missing. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. '403': description: Returned if the user does not have the necessary permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. deprecated: false security: - basicAuth: [] - OAuth2: - manage:jira-configuration put: tags: - Announcement banner summary: setBanner description: >- Updates the announcement banner configuration. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: setBanner parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/AnnouncementBannerConfigurationUpdate' - example: isDismissible: false isEnabled: true message: This is a public, enabled, non-dismissible banner, set using the API visibility: public example: isDismissible: false isEnabled: true message: This is a public, enabled, non-dismissible banner, set using the API visibility: public required: true responses: '204': description: Returned if the request is successful. headers: {} content: application/json: schema: {} '400': description: Returned if an invalid parameter is passed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. '401': description: Returned if the authentication credentials are incorrect or missing. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. '403': description: Returned if the user does not have the necessary permission. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. deprecated: false security: - basicAuth: [] - OAuth2: - manage:jira-configuration /rest/api/3/applicationrole: get: tags: - Application roles summary: getAllApplicationRoles description: >- Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: getAllApplicationRoles parameters: [] responses: '200': description: Returned if the request is successful. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ApplicationRole' description: '' example: - key: jira-software groups: - jira-software-users - jira-testers groupDetails: - name: jira-testers groupId: 42c8955c-63d7-42c8-9520-63d7aca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625 - name: jira-software-users groupId: 276f955c-63d7-42c8-9520-92d01dca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625 name: Jira Software defaultGroups: - jira-software-users defaultGroupsDetails: - name: jira-software-users groupId: 276f955c-63d7-42c8-9520-92d01dca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625 selectedByDefault: false defined: false numberOfSeats: 10 remainingSeats: 5 userCount: 5 userCountDescription: 5 developers hasUnlimitedSeats: false platform: false - key: jira-core groups: - jira-core-users groupDetails: - name: jira-core-users groupId: 92d01dca0625-42c8-42c8-9520-276f955c self: https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c name: Jira Core defaultGroups: - jira-core-users defaultGroupsDetails: - name: jira-core-users groupId: 92d01dca0625-42c8-42c8-9520-276f955c self: https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c selectedByDefault: false defined: false numberOfSeats: 1 remainingSeats: 1 userCount: 0 userCountDescription: 0 users hasUnlimitedSeats: false platform: true example: - key: jira-software groups: - jira-software-users - jira-testers groupDetails: - name: jira-testers groupId: 42c8955c-63d7-42c8-9520-63d7aca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625 - name: jira-software-users groupId: 276f955c-63d7-42c8-9520-92d01dca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625 name: Jira Software defaultGroups: - jira-software-users defaultGroupsDetails: - name: jira-software-users groupId: 276f955c-63d7-42c8-9520-92d01dca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625 selectedByDefault: false defined: false numberOfSeats: 10 remainingSeats: 5 userCount: 5 userCountDescription: 5 developers hasUnlimitedSeats: false platform: false - key: jira-core groups: - jira-core-users groupDetails: - name: jira-core-users groupId: 92d01dca0625-42c8-42c8-9520-276f955c self: https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c name: Jira Core defaultGroups: - jira-core-users defaultGroupsDetails: - name: jira-core-users groupId: 92d01dca0625-42c8-42c8-9520-276f955c self: https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c selectedByDefault: false defined: false numberOfSeats: 1 remainingSeats: 1 userCount: 0 userCountDescription: 0 users hasUnlimitedSeats: false platform: true '401': description: Returned if the authentication credentials are incorrect or missing. headers: {} content: {} '403': description: Returned if the user is not an administrator. headers: {} content: {} deprecated: false security: - basicAuth: [] /rest/api/3/applicationrole/{key}: get: tags: - Application roles summary: getApplicationRole description: >- Returns an application role. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: getApplicationRole parameters: - name: key in: path description: The key of the application role. Use the [Get all application roles](#api-rest-api-3-applicationrole-get) operation to get the key for each application role. required: true style: simple schema: type: string example: jira-software responses: '200': description: Returned if the request is successful. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ApplicationRole' - description: Details of an application role. example: key: jira-software groups: - jira-software-users - jira-testers groupDetails: - name: jira-testers groupId: 42c8955c-63d7-42c8-9520-63d7aca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625 - name: jira-software-users groupId: 276f955c-63d7-42c8-9520-92d01dca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625 name: Jira Software defaultGroups: - jira-software-users defaultGroupsDetails: - name: jira-software-users groupId: 276f955c-63d7-42c8-9520-92d01dca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625 selectedByDefault: false defined: false numberOfSeats: 10 remainingSeats: 5 userCount: 5 userCountDescription: 5 developers hasUnlimitedSeats: false platform: false example: key: jira-software groups: - jira-software-users - jira-testers groupDetails: - name: jira-testers groupId: 42c8955c-63d7-42c8-9520-63d7aca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625 - name: jira-software-users groupId: 276f955c-63d7-42c8-9520-92d01dca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625 name: Jira Software defaultGroups: - jira-software-users defaultGroupsDetails: - name: jira-software-users groupId: 276f955c-63d7-42c8-9520-92d01dca0625 self: https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625 selectedByDefault: false defined: false numberOfSeats: 10 remainingSeats: 5 userCount: 5 userCountDescription: 5 developers hasUnlimitedSeats: false platform: false '401': description: Returned if the authentication credentials are incorrect or missing. headers: {} content: {} '403': description: Returned if the user is not an administrator. headers: {} content: {} '404': description: Returned if the role is not found. headers: {} content: {} deprecated: false security: - basicAuth: [] /rest/api/3/auditing/record: get: tags: - Audit records summary: getAuditRecords description: "Returns a list of audit records. The list can be filtered to include items:\n\n * where each item in `filter` has at least one match in any of these fields:\n \n * `summary`\n * `category`\n * `eventSource`\n * `objectItem.name` If the object is a user, account ID is available to filter.\n * `objectItem.parentName`\n * `objectItem.typeName`\n * `changedValues.changedFrom`\n * `changedValues.changedTo`\n * `remoteAddress`\n \n For example, if `filter` contains *man ed*, an audit record containing `summary\": \"User added to group\"` and `\"category\": \"group management\"` is returned.\n * created on or after a date and time.\n * created or or before a date and time.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." operationId: getAuditRecords parameters: - name: offset in: query description: The number of records to skip before returning the first result. style: form explode: true schema: type: integer format: int32 default: 0 - name: limit in: query description: The maximum number of results to return. style: form explode: true schema: type: integer format: int32 default: 1000 - name: filter in: query description: The strings to match with audit field content, space separated. style: form explode: true schema: type: string - name: from in: query description: The date and time on or after which returned audit records must have been created. If `to` is provided `from` must be before `to` or no audit records are returned. style: form explode: true schema: type: string format: date-time - name: to in: query description: The date and time on or before which returned audit results must have been created. If `from` is provided `to` must be after `from` or no audit records are returned. style: form explode: true schema: type: string format: date-time responses: '200': description: Returned if the request is successful. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/AuditRecords' - description: Container for a list of audit records. example: offset: 0 limit: 1000 total: 1 records: - id: 1 summary: User created remoteAddress: 192.168.1.1 authorKey: administrator authorAccountId: 5ab8f18d741e9c2c7e9d4538 created: 2014-03-19T18:45:42.967+0000 category: user management eventSource: Jira Connect Plugin description: Optional description objectItem: id: user name: user typeName: USER parentId: '1' parentName: Jira Internal Directory changedValues: - fieldName: email changedFrom: user@atlassian.com changedTo: newuser@atlassian.com associatedItems: - id: jira-software-users name: jira-software-users typeName: GROUP parentId: '1' parentName: Jira Internal Directory example: offset: 0 limit: 1000 total: 1 records: - id: 1 summary: User created remoteAddress: 192.168.1.1 authorKey: administrator authorAccountId: 5ab8f18d741e9c2c7e9d4538 created: 2014-03-19T18:45:42.967+0000 category: user management eventSource: Jira Connect Plugin description: Optional description objectItem: id: user name: user typeName: USER parentId: '1' parentName: Jira Internal Directory changedValues: - fieldName: email changedFrom: user@atlassian.com changedTo: newuser@atlassian.com associatedItems: - id: jira-software-users name: jira-software-users typeName: GROUP parentId: '1' parentName: Jira Internal Directory '401': description: Returned if the authentication credentials are incorrect or missing. headers: {} content: {} '403': description: >- Returned if: * the user does not have the required permissions. * all Jira products are on free plans. Audit logs are available when at least one Jira product is on a paid plan. headers: {} content: {} deprecated: false security: - basicAuth: [] - OAuth2: - manage:jira-configuration /rest/api/3/avatar/{type}/system: get: tags: - Avatars summary: getAllSystemAvatars description: >- Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. operationId: getAllSystemAvatars parameters: - name: type in: path description: The avatar type. required: true style: simple schema: allOf: - $ref: '#/components/schemas/type16' - description: The avatar type. example: project responses: '200': description: Returned if the request is successful. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/SystemAvatars' - description: List of system avatars. example: system: - 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 example: system: - 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 '401': description: Returned if the authentication credentials are incorrect or missing. headers: {} content: {} '500': description: Returned if an error occurs while retrieving the list of avatars. headers: {} content: {} deprecated: false security: - basicAuth: [] - OAuth2: - manage:jira-configuration - {} /rest/api/3/universal_avatar/type/{type}/owner/{entityId}: get: tags: - Avatars summary: getAvatars description: >- Returns the system and custom avatars for a project or issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * for custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the avatar belongs to. * for custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the issue type is used in. * for system avatars, none. operationId: getAvatars parameters: - name: type in: path description: The avatar type. required: true style: simple schema: allOf: - $ref: '#/components/schemas/type18' - description: The avatar type. - name: entityId in: path description: The ID of the item the avatar is associated with. required: true style: simple schema: type: string responses: '200': description: Returned if the request is successful. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Avatars' - description: Details about system and custom avatars. example: system: - id: '1000' isSystemAvatar: true isSelected: false isDeletable: false 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 custom: - id: '1010' isSystemAvatar: false isSelected: false isDeletable: true 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 example: system: - id: '1000' isSystemAvatar: true isSelected: false isDeletable: false 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 custom: - id: '1010' isSystemAvatar: false isSelected: false isDeletable: true 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 '401': description: Returned if the authentication credentials are incorrect or missing. headers: {} content: {} '404': description: Returned if the avatar type is invalid, the associated item ID is missing, or the item is not found. headers: {} content: {} deprecated: false security: - basicAuth: [] - OAuth2: - manage:jira-configuration - {} post: tags: - Avatars summary: storeAvatar description: "Loads a custom avatar for a project or issue type.\n\nSpecify the avatar's local file location in the body of the request. Also, include the following headers:\n\n * `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers).\n * `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG.\n\nFor example: \n`curl --request POST `\n\n`--user email@example.com:<api_token> `\n\n`--header 'X-Atlassian-Token: no-check' `\n\n`--header 'Content-Type: image/< image_type>' `\n\n`--data-binary \"<@/path/to/file/with/your/avatar>\" `\n\n`--url 'https://your-domain.atlassian.net/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'`\n\nThe 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.\n\nThe cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.\n\nAfter creating the avatar use:\n\n * [Update issue type](#api-rest-api-3-issuetype-id-put) to set it as the issue type's displayed avatar.\n * [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project's displayed avatar.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." operationId: storeAvatar parameters: - name: type in: path description: The avatar type. required: true style: simple schema: allOf: - $ref: '#/components/schemas/type18' - description: The avatar type. - name: entityId in: path description: The ID of the item the avatar is associated with. required: true style: simple schema: type: string - name: x in: query description: The X coordinate of the top-left corner of the crop region. style: form explode: true schema: type: integer format: int32 default: 0 - name: y in: query description: The Y coordinate of the top-left corner of the crop region. style: form explode: true schema: type: integer format: int32 default: 0 - name: size in: query description: The length of each side of the crop region. required: true style: form explode: true schema: type: integer format: int32 requestBody: description: '' content: '*/*': schema: {} required: true responses: '201': description: Returned if the request is successful. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Avatar' - description: Details of an avatar. example: 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 example: 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 '400': description: >- Returned 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. headers: {} content: {} '401': description: Returned if the authentication credentials are incorrect or missing. headers: {} content: {} '403': description: Returned if the user does not have the necessary permissions. headers: {} content: {} '404': description: Returned if the avatar type is invalid, the associated item ID is missing, or the item is not found. headers: {} content: {} deprecated: false security: - basicAuth: [] - OAuth2: - manage:jira-configuration - {} /rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}: delete: tags: - Avatars summary: deleteAvatar description: >- Deletes an avatar from a project or issue type. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). operationId: deleteAvatar parameters: - name: type in: path description: The avatar type. required: true style: simple schema: allOf: - $ref: '#/components/schemas/type18' - description: The avatar type. - name: owningObjectId in: path description: The ID of the item the avatar is associated with. required: true style: simple schema: type: string - name: id in: path description: The ID of the avatar. required: true style: simple schema: type: integer format: int64 responses: '204': description: Returned if the request is successful. headers: {} content: {} '400': description: Returned if the request is invalid. headers: {} content: {} '403': description: Returned if the user does not have permission to delete the avatar, the avatar is not deletable. headers: {} content: {} '404': description: Returned if the avatar type, associated item ID, or avatar ID is invalid. headers: {} content: {} deprecated: false security: - basicAuth: [] - OAuth2: - manage:jira-configuration - {} /rest/api/3/universal_avatar/view/type/{type}: get: tags: - Avatars summary: getAvatarImageByType description: >- Returns the default project or issue type avatar image. This operation can be accessed anonymously. **[Permissions](#permissions) required:** None. operationId: getAvatarImageByType parameters: - name: type in: path description: The icon type of the avatar. required: true style: simple schema: allOf: - $ref: '#/components/schemas/type18' - description: The icon type of the avatar. - name: size in: query description: The size of the avatar image. If not provided the default size is returned. style: form explode: true schema: allOf: - $ref: '#/components/schemas/size' - description: The size of the avatar image. If not provided the default size is returned. - name: format in: query description: The format to return the avatar image in. If not provided the original content format is returned. style: form explode: true schema: allOf: - $ref: '#/components/schemas/format' - description: The format to return the avatar image in. If not provided the original content format is returned. responses: '200': description: Returned if the request is successful. headers: {} content: application/json: schema: type: object image/png: schema: {} '401': description: Returned if the authentication credentials are incorrect. headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeResponse' - example: errorMessages: - Human readable error message errors: {} example: errorMessages: - Human readable error message errors: {} application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. image/png: schema: {} image/svg+xml: schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeResponse' - xml: name: RestApi3UniversalAvatarViewTypeResponse attribute: false wrapped: false '403': description: Returned if the user does not have the necessary permission. headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeResponse' - example: errorMessages: - Human readable error message errors: {} example: errorMessages: - Human readable error message errors: {} application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. image/png: schema: {} image/svg+xml: schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeResponse' - xml: name: RestApi3UniversalAvatarViewTypeResponse attribute: false wrapped: false '404': description: Returned if an avatar is not found or an avatar matching the requested size is not found. headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeResponse' - example: errorMessages: - Human readable error message errors: {} example: errorMessages: - Human readable error message errors: {} application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. image/png: schema: {} image/svg+xml: schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeResponse' - xml: name: RestApi3UniversalAvatarViewTypeResponse attribute: false wrapped: false deprecated: false security: - basicAuth: [] - OAuth2: - read:jira-work - {} /rest/api/3/universal_avatar/view/type/{type}/avatar/{id}: get: tags: - Avatars summary: getAvatarImageByID description: >- Returns a project or issue type avatar image by ID. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * For system avatars, none. * For custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the avatar belongs to. * For custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the issue type is used in. operationId: getAvatarImageByID parameters: - name: type in: path description: The icon type of the avatar. required: true style: simple schema: allOf: - $ref: '#/components/schemas/type18' - description: The icon type of the avatar. - name: id in: path description: The ID of the avatar. required: true style: simple schema: type: integer format: int64 - name: size in: query description: The size of the avatar image. If not provided the default size is returned. style: form explode: true schema: allOf: - $ref: '#/components/schemas/size' - description: The size of the avatar image. If not provided the default size is returned. - name: format in: query description: The format to return the avatar image in. If not provided the original content format is returned. style: form explode: true schema: allOf: - $ref: '#/components/schemas/format' - description: The format to return the avatar image in. If not provided the original content format is returned. responses: '200': description: Returned if the request is successful. headers: {} content: application/json: schema: type: object image/png: schema: {} '400': description: Returned if the request is not valid. headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeAvatarResponse' - example: errorMessages: - Human readable error message errors: {} example: errorMessages: - Human readable error message errors: {} application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. image/png: schema: {} image/svg+xml: schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeAvatarResponse' - xml: name: RestApi3UniversalAvatarViewTypeAvatarResponse attribute: false wrapped: false '401': description: Returned if the authentication credentials are incorrect. headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeAvatarResponse' - example: errorMessages: - Human readable error message errors: {} example: errorMessages: - Human readable error message errors: {} application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. image/png: schema: {} image/svg+xml: schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeAvatarResponse' - xml: name: RestApi3UniversalAvatarViewTypeAvatarResponse attribute: false wrapped: false '403': description: Returned if the user does not have the necessary permission. headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeAvatarResponse' - example: errorMessages: - Human readable error message errors: {} example: errorMessages: - Human readable error message errors: {} application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. image/png: schema: {} image/svg+xml: schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeAvatarResponse' - xml: name: RestApi3UniversalAvatarViewTypeAvatarResponse attribute: false wrapped: false '404': description: Returned if an avatar is not found or an avatar matching the requested size is not found. headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeAvatarResponse' - example: errorMessages: - Human readable error message errors: {} example: errorMessages: - Human readable error message errors: {} application/json: schema: allOf: - $ref: '#/components/schemas/ErrorCollection' - description: Error messages from an operation. image/png: schema: {} image/svg+xml: schema: allOf: - $ref: '#/components/schemas/RestApi3UniversalAvatarViewTypeAvatarResponse' - xml: name: RestApi3UniversalAvatarViewTypeAvatarResponse attribute: false wrapped: false deprecated: false security: - basicAuth: [] - OAuth2: - read:jira-work - {} /rest/api/3/universal_avatar/view/type/{type}/owner/{entityId}: get: tags: - Avatars summary: getAvatarImageByOwner description: >- Returns the avatar image for a project or issue type. This operation can be accessed anonymously. **[Permissions](#permissions) required:** * For system avatars, none. * For custom project avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the avatar belongs to. * For custom issue type avatars, *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one project the issue type is used in. operationId: getAvatarImageByOwner parameters: - name: type in: path description: The icon type of the avatar. required: true style: simple schema: allOf: - $ref: '#/components/schemas/type18' - description: The icon type of the avatar. - name: entityId in: path description: The ID of the project or issue type the avatar belongs to. required: true style: simple schema: type: string - name: size in: query description: The size of the avatar image. If not provided the default size is returned. style: form explode: true schema: allOf: - $ref: '#/components/schemas/size' - description: The size of the avatar image. If not provided the default size is returned. - name: format in: query description: The format to return the avatar image in. If not provided the original content format is returned. style: form explode: true schema: allOf: - $ref: '#/components/schemas/format' - description: The format to return the avatar image in. If not provided the original content format is returned. responses: '200': description: Returned if the request is successful. headers: {} content: application/json: schema: type: object image/p