Atlassian: Get project role details

Atlassian projectRoles.getProjectRoleDetails: arguments, response, policy and SDK examples.

← Project roles operations · Get started

Operation atlassian.getprojectroledetails

Provider route: GET /{cloudId}/rest/api/3/project/{projectIdOrKey}/roledetails. 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["projectRoles"]["getProjectRoleDetails"]>[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.projectRoles.getProjectRoleDetails(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.project_roles.get_project_role_details(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.projectIdOrKey`	string	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.currentMember`	boolean	Optional	Default: false
`query.excludeConnectAddons`	boolean	Optional	Default: false
`query.excludeOtherServiceRoles`	boolean	Optional	Default: false

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
`$`	array	Root
`$[]`	Model	Each item	Expand Get project role details — response body — item

Referenced models: Get project role details — response body — item

Schemas

Get project role details — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a project role.
`admin`	JSON	Optional
`admin (anyOf 1)`	boolean	Alternative	Whether this role is the admin role for the project. Read only: true
`admin (anyOf 2)`	null	Alternative
`default`	JSON	Optional
`default (anyOf 1)`	boolean	Alternative	Whether this role is the default role for the project. Read only: true
`default (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the project role. Read only: true
`description (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the project role. Format: int64 Read only: true
`id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the project role.
`name (anyOf 2)`	null	Alternative
`roleConfigurable`	JSON	Optional
`roleConfigurable (anyOf 1)`	boolean	Alternative	Whether the roles are configurable for this project. Read only: true
`roleConfigurable (anyOf 2)`	null	Alternative
`scope`	JSON	Optional
`scope (anyOf 1)`	Model	Alternative	Expand Get status — response body — scope project, type The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). Read only: true
`scope (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL the project role details. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative
`translatedName`	JSON	Optional
`translatedName (anyOf 1)`	string	Alternative	The translated name of the project role.
`translatedName (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of the project role. This is "DEFAULT" or "GUEST\_ROLE". Known values: DEFAULT, GUEST_ROLE, AI_AGENT_ROLE Read only: true
`type (anyOf 2)`	null	Alternative

Referenced models: Get status — response body — scope project, type

Get status — response body — scope project, type

Field	Type	Presence	Description and constraints
`$`	object	Root	The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). Additional keys: allowed
`project`	JSON	Optional
`project (anyOf 1)`	Model	Alternative	Expand Get issue type screen scheme projects — response body — values The list of items item The project the item has scope in. Read only: true
`project (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of scope. Known values: PROJECT, TEMPLATE Read only: true
`type (anyOf 2)`	null	Alternative

Referenced models: Get issue type screen scheme projects — response body — values The list of items item

Get issue type screen scheme projects — response body — values The list of items item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a project.
`avatarUrls`	JSON	Optional
`avatarUrls (anyOf 1)`	Model	Alternative	Expand Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48 The URLs of the project's avatars. Read only: true
`avatarUrls (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the project.
`id (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the project. Read only: true
`key (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the project. Read only: true
`name (anyOf 2)`	null	Alternative
`projectCategory`	JSON	Optional
`projectCategory (anyOf 1)`	Model	Alternative	Expand Update project category — response body The category the project belongs to. Read only: true
`projectCategory (anyOf 2)`	null	Alternative
`projectTypeKey`	JSON	Optional
`projectTypeKey (anyOf 1)`	string	Alternative	The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. Known values: software, service_desk, business, product_discovery Read only: true
`projectTypeKey (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the project details. Read only: true
`self (anyOf 2)`	null	Alternative
`simplified`	JSON	Optional
`simplified (anyOf 1)`	boolean	Alternative	Whether or not the project is simplified. Read only: true
`simplified (anyOf 2)`	null	Alternative

Referenced models: Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48, Update project category — response body

Get user — response body — avatar Urls 16x16, 24x24, 32x32, 48x48

Field	Type	Presence	Description and constraints
`$`	object	Root
`16x16`	JSON	Optional
`16x16 (anyOf 1)`	string	Alternative	The URL of the item's 16x16 pixel avatar. Format: uri
`16x16 (anyOf 2)`	null	Alternative
`24x24`	JSON	Optional
`24x24 (anyOf 1)`	string	Alternative	The URL of the item's 24x24 pixel avatar. Format: uri
`24x24 (anyOf 2)`	null	Alternative
`32x32`	JSON	Optional
`32x32 (anyOf 1)`	string	Alternative	The URL of the item's 32x32 pixel avatar. Format: uri
`32x32 (anyOf 2)`	null	Alternative
`48x48`	JSON	Optional
`48x48 (anyOf 1)`	string	Alternative	The URL of the item's 48x48 pixel avatar. Format: uri
`48x48 (anyOf 2)`	null	Alternative

Update project category — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A project category.
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The name of the project category. Read only: true
`description (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the project category. Read only: true
`id (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The description of the project category. Read only: true
`name (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the project category. Read only: true
`self (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: atlassian.getprojectroledetails. Catalog operation: getprojectroledetails. 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

Report an issue with this page