Atlassian: Assign issue

← Issues operations · Get started

Operation atlassian.assignissue

Provider route: PUT /{cloudId}/rest/api/3/issue/{issueIdOrKey}/assignee. 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 } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["issues"]["assignIssue"]>[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.issues.assignIssue(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
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.issues.assign_issue(arguments)
        result = await call.wait()
        return result.body_json()

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.issueIdOrKey	string	Required within parent
body	Model	Required within parent	Expand Assign issue — request body — body

Referenced models: Assign issue — request body — body

Response

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

Field	Type	Presence	Description and constraints
$	null	Root

Schemas

Assign issue — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values. Additional keys: not allowed
accountId	string	Optional	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. Maximum length: 128
accountType	string	Optional	The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk One of: atlassian, app, customer, unknown Read only: true
active	boolean	Optional	Whether the user is active. Read only: true
appType	string	Optional	The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type Read only: true
applicationRoles	Model	Optional	Expand Assign issue — request body — body application Roles The application roles the user is assigned to. Read only: true
avatarUrls	Model	Optional	Expand Assign issue — request body — body avatar Urls The avatars of the user. Read only: true
displayName	string	Optional	The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. Read only: true
emailAddress	string	Optional	The email address of the user. Depending on the user’s privacy setting, this may be returned as null. Read only: true
expand	string	Optional	Expand options that include additional user details in the response. Read only: true
groups	Model	Optional	Expand Assign issue — request body — body groups The groups that the user belongs to. Read only: true
guest	boolean	Optional	Whether the user is a guest. Read only: true
key	string	Optional	This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
locale	string	Optional	The locale of the user. Depending on the user’s privacy setting, this may be returned as null. Read only: true
name	string	Optional	This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
self	string	Optional	The URL of the user. Format: uri Read only: true
timeZone	string	Optional	The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. Read only: true

Referenced models: Assign issue — request body — body avatar Urls, Assign issue — request body — body application Roles, Assign issue — request body — body groups

Assign issue — request body — body avatar Urls

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
16x16	string	Optional	The URL of the item's 16x16 pixel avatar. Format: uri
24x24	string	Optional	The URL of the item's 24x24 pixel avatar. Format: uri
32x32	string	Optional	The URL of the item's 32x32 pixel avatar. Format: uri
48x48	string	Optional	The URL of the item's 48x48 pixel avatar. Format: uri

Assign issue — request body — body application Roles

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
callback	Model	Optional	Expand Assign issue — request body — body groups callback
items	array	Optional
items[]	Model	Each item	Expand Assign issue — request body — body application Roles items item
max-results	integer	Optional	Format: int32
pagingCallback	Model	Optional	Expand Assign issue — request body — body groups callback
size	integer	Optional	Format: int32

Referenced models: Assign issue — request body — body application Roles items item, Assign issue — request body — body groups callback

Assign issue — request body — body groups

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
callback	Model	Optional	Expand Assign issue — request body — body groups callback
items	array	Optional
items[]	Model	Each item	Expand Send notification for issue — request body — body to groups item
max-results	integer	Optional	Format: int32
pagingCallback	Model	Optional	Expand Assign issue — request body — body groups callback
size	integer	Optional	Format: int32

Referenced models: Assign issue — request body — body groups callback, Send notification for issue — request body — body to groups item

Assign issue — request body — body application Roles items item

Field	Type	Presence	Description and constraints
$	object	Root	Details of an application role. Additional keys: not allowed
defaultGroups	array	Optional	The groups that are granted default access for this application role. As a group's name can change, use of `defaultGroupsDetails` is recommended to identify a groups. Unique items: true
defaultGroups[]	string	Each item
defaultGroupsDetails	array	Optional	The groups that are granted default access for this application role.
defaultGroupsDetails[]	Model	Each item	Expand Send notification for issue — request body — body to groups item
defined	boolean	Optional	Deprecated.
groupDetails	array	Optional	The groups associated with the application role.
groupDetails[]	Model	Each item	Expand Send notification for issue — request body — body to groups item
groups	array	Optional	The groups associated with the application role. As a group's name can change, use of `groupDetails` is recommended to identify a groups. Unique items: true
groups[]	string	Each item
hasUnlimitedSeats	boolean	Optional
key	string	Optional	The key of the application role.
name	string	Optional	The display name of the application role.
numberOfSeats	integer	Optional	The maximum count of users on your license. Format: int32
platform	boolean	Optional	Indicates if the application role belongs to Jira platform (`jira-core`).
remainingSeats	integer	Optional	The count of users remaining on your license. Format: int32
selectedByDefault	boolean	Optional	Determines whether this application role should be selected by default on user creation.
userCount	integer	Optional	The number of users counting against your license. Format: int32
userCountDescription	string	Optional	The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license.

Referenced models: Send notification for issue — request body — body to groups item

Assign issue — request body — body groups callback

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed

Send notification for issue — request body — body to groups item

Field	Type	Presence	Description and constraints
$	object	Root	Details about a group. Additional keys: not allowed
groupId	JSON	Optional
groupId (anyOf 1)	string	Alternative	The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
groupId (anyOf 2)	null	Alternative
name	string	Optional	The name of group.
self	string	Optional	The URL for these group details. Format: uri Read only: true

Policy, approvals and errors

SDK function policy ID: atlassian.assignissue. Catalog operation: assignissue. 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: ["write:jira-work"]

No-content response statuses: [204]

Official provider source