Atlassian: Get avatar image by type

← Avatars operations · Get started

Operation atlassian.getavatarimagebytype

Provider route: GET /{cloudId}/rest/api/3/universal_avatar/view/type/{type}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App, BackendError, ProviderAPIError } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["avatars"]["getAvatarImageByType"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.avatars.getAvatarImageByType(input);
    const result = await call.wait();
    if (result.statusCode < 200 || result.statusCode >= 300)
      throw new ProviderAPIError("Provider download failed", result.statusCode);
    if (result.response.bodyTruncated)
      throw new BackendError("Provider download was truncated");
    return result.bodyBytes();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk.exceptions import BackendError, ProviderAPIError
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.avatars.get_avatar_image_by_type(arguments)
        result = await call.wait()
        if not 200 <= result.status_code < 300:
            raise ProviderAPIError("Provider download failed", result.status_code)
        if result.response.body_truncated:
            raise BackendError("Provider download was truncated")
        return result.body_bytes()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
path.type	string	Required within parent	One of: issuetype, project, priority
query	object	Optional	Additional keys: not allowed
query.size	string	Optional	One of: xsmall, small, medium, large, xlarge
query.format	string	Optional	One of: png, svg

Response

Response media type: */*. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root

Policy, approvals and errors

SDK function policy ID: atlassian.getavatarimagebytype. Catalog operation: getavatarimagebytype. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["read:jira-work"]

Official provider source