Atlassian The Jira Cloud platform REST API — Avatars

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Jira Cloud platform REST API — Avatars
  description: 'Atlassian The Jira Cloud platform REST API — Avatars. 7 operations. Lead operation: Atlassian Get System Avatars
    By Type. Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Avatars
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: jira-avatars
    baseUri: https://your-domain.atlassian.net
    description: Atlassian The Jira Cloud platform REST API — Avatars business capability. Self-contained, no shared references.
    resources:
    - name: rest-api-3-avatar-type-system
      path: /rest/api/3/avatar/{type}/system
      operations:
      - name: atlassiangetallsystemavatars
        method: GET
        description: Atlassian Get System Avatars By Type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: The avatar type.
          required: true
    - name: rest-api-3-universal_avatar-type-type-owner-entityId
      path: /rest/api/3/universal_avatar/type/{type}/owner/{entityId}
      operations:
      - name: atlassiangetavatars
        method: GET
        description: Atlassian Get Avatars
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: The avatar type.
          required: true
        - name: entityId
          in: path
          type: string
          description: The ID of the item the avatar is associated with.
          required: true
      - name: atlassianstoreavatar
        method: POST
        description: Atlassian Load Avatar
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: The avatar type.
          required: true
        - name: entityId
          in: path
          type: string
          description: The ID of the item the avatar is associated with.
          required: true
        - name: x
          in: query
          type: integer
          description: The X coordinate of the top-left corner of the crop region.
        - name: y
          in: query
          type: integer
          description: The Y coordinate of the top-left corner of the crop region.
        - name: size
          in: query
          type: integer
          description: The length of each side of the crop region.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-universal_avatar-type-type-owner-owningObjectId-avatar-id
      path: /rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}
      operations:
      - name: atlassiandeleteavatar
        method: DELETE
        description: Atlassian Delete Avatar
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: The avatar type.
          required: true
        - name: owningObjectId
          in: path
          type: string
          description: The ID of the item the avatar is associated with.
          required: true
        - name: id
          in: path
          type: integer
          description: The ID of the avatar.
          required: true
    - name: rest-api-3-universal_avatar-view-type-type
      path: /rest/api/3/universal_avatar/view/type/{type}
      operations:
      - name: atlassiangetavatarimagebytype
        method: GET
        description: Atlassian Get Avatar Image By Type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: The icon type of the avatar.
          required: true
        - name: size
          in: query
          type: string
          description: The size of the avatar image. If not provided the default size is returned.
        - name: format
          in: query
          type: string
          description: The format to return the avatar image in. If not provided the original content format is returned.
    - name: rest-api-3-universal_avatar-view-type-type-avatar-id
      path: /rest/api/3/universal_avatar/view/type/{type}/avatar/{id}
      operations:
      - name: atlassiangetavatarimagebyid
        method: GET
        description: Atlassian Get Avatar Image By Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: The icon type of the avatar.
          required: true
        - name: id
          in: path
          type: integer
          description: The ID of the avatar.
          required: true
        - name: size
          in: query
          type: string
          description: The size of the avatar image. If not provided the default size is returned.
        - name: format
          in: query
          type: string
          description: The format to return the avatar image in. If not provided the original content format is returned.
    - name: rest-api-3-universal_avatar-view-type-type-owner-entityId
      path: /rest/api/3/universal_avatar/view/type/{type}/owner/{entityId}
      operations:
      - name: atlassiangetavatarimagebyowner
        method: GET
        description: Atlassian Get Avatar Image By Owner
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: The icon type of the avatar.
          required: true
        - name: entityId
          in: path
          type: string
          description: The ID of the project or issue type the avatar belongs to.
          required: true
        - name: size
          in: query
          type: string
          description: The size of the avatar image. If not provided the default size is returned.
        - name: format
          in: query
          type: string
          description: The format to return the avatar image in. If not provided the original content format is returned.
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: jira-avatars-rest
    port: 8080
    description: REST adapter for Atlassian The Jira Cloud platform REST API — Avatars. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/avatar/{type}/system
      name: rest-api-3-avatar-type-system
      description: REST surface for rest-api-3-avatar-type-system.
      operations:
      - method: GET
        name: atlassiangetallsystemavatars
        description: Atlassian Get System Avatars By Type
        call: jira-avatars.atlassiangetallsystemavatars
        with:
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/universal-avatar/type/{type}/owner/{entityid}
      name: rest-api-3-universal-avatar-type-type-owner-entityid
      description: REST surface for rest-api-3-universal_avatar-type-type-owner-entityId.
      operations:
      - method: GET
        name: atlassiangetavatars
        description: Atlassian Get Avatars
        call: jira-avatars.atlassiangetavatars
        with:
          type: rest.type
          entityId: rest.entityId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassianstoreavatar
        description: Atlassian Load Avatar
        call: jira-avatars.atlassianstoreavatar
        with:
          type: rest.type
          entityId: rest.entityId
          x: rest.x
          y: rest.y
          size: rest.size
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/universal-avatar/type/{type}/owner/{owningobjectid}/avatar/{id}
      name: rest-api-3-universal-avatar-type-type-owner-owningobjectid-avatar-id
      description: REST surface for rest-api-3-universal_avatar-type-type-owner-owningObjectId-avatar-id.
      operations:
      - method: DELETE
        name: atlassiandeleteavatar
        description: Atlassian Delete Avatar
        call: jira-avatars.atlassiandeleteavatar
        with:
          type: rest.type
          owningObjectId: rest.owningObjectId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/universal-avatar/view/type/{type}
      name: rest-api-3-universal-avatar-view-type-type
      description: REST surface for rest-api-3-universal_avatar-view-type-type.
      operations:
      - method: GET
        name: atlassiangetavatarimagebytype
        description: Atlassian Get Avatar Image By Type
        call: jira-avatars.atlassiangetavatarimagebytype
        with:
          type: rest.type
          size: rest.size
          format: rest.format
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/universal-avatar/view/type/{type}/avatar/{id}
      name: rest-api-3-universal-avatar-view-type-type-avatar-id
      description: REST surface for rest-api-3-universal_avatar-view-type-type-avatar-id.
      operations:
      - method: GET
        name: atlassiangetavatarimagebyid
        description: Atlassian Get Avatar Image By Id
        call: jira-avatars.atlassiangetavatarimagebyid
        with:
          type: rest.type
          id: rest.id
          size: rest.size
          format: rest.format
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/universal-avatar/view/type/{type}/owner/{entityid}
      name: rest-api-3-universal-avatar-view-type-type-owner-entityid
      description: REST surface for rest-api-3-universal_avatar-view-type-type-owner-entityId.
      operations:
      - method: GET
        name: atlassiangetavatarimagebyowner
        description: Atlassian Get Avatar Image By Owner
        call: jira-avatars.atlassiangetavatarimagebyowner
        with:
          type: rest.type
          entityId: rest.entityId
          size: rest.size
          format: rest.format
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: jira-avatars-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Jira Cloud platform REST API — Avatars. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: atlassian-get-system-avatars-type
      description: Atlassian Get System Avatars By Type
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-avatars.atlassiangetallsystemavatars
      with:
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-avatars
      description: Atlassian Get Avatars
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-avatars.atlassiangetavatars
      with:
        type: tools.type
        entityId: tools.entityId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-load-avatar
      description: Atlassian Load Avatar
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-avatars.atlassianstoreavatar
      with:
        type: tools.type
        entityId: tools.entityId
        x: tools.x
        y: tools.y
        size: tools.size
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-avatar
      description: Atlassian Delete Avatar
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-avatars.atlassiandeleteavatar
      with:
        type: tools.type
        owningObjectId: tools.owningObjectId
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-avatar-image-type
      description: Atlassian Get Avatar Image By Type
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-avatars.atlassiangetavatarimagebytype
      with:
        type: tools.type
        size: tools.size
        format: tools.format
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-avatar-image-id
      description: Atlassian Get Avatar Image By Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-avatars.atlassiangetavatarimagebyid
      with:
        type: tools.type
        id: tools.id
        size: tools.size
        format: tools.format
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-avatar-image-owner
      description: Atlassian Get Avatar Image By Owner
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-avatars.atlassiangetavatarimagebyowner
      with:
        type: tools.type
        entityId: tools.entityId
        size: tools.size
        format: tools.format
      outputParameters:
      - type: object
        mapping: $.