Atlassian: Assign permission scheme

Atlassian projectPermissionSchemes.assignPermissionScheme: arguments, response, policy and SDK examples.

← Project permission schemes operations · Get started

Operation atlassian.assignpermissionscheme

Provider route: PUT /{cloudId}/rest/api/3/project/{projectKeyOrId}/permissionscheme. 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["projectPermissionSchemes"]["assignPermissionScheme"]>[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.projectPermissionSchemes.assignPermissionScheme(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_permission_schemes.assign_permission_scheme(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.projectKeyOrId`	string	Required within parent
`query`	object	Optional	Additional keys: not allowed
`query.expand`	string	Optional
`body`	Model	Required within parent	Expand Assign permission scheme — request body — body

Referenced models: Assign permission scheme — 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
`$`	Model	Root	Expand Get permission scheme — response body

Referenced models: Get permission scheme — response body

Schemas

2 more schemas are linked from the tables above, on the schema pages.

Assign permission scheme — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`id`	integer	Required within parent	The ID of the permission scheme to associate with the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to get a list of permission scheme IDs. Format: int64

Get permission scheme — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a permission scheme. Additional keys: allowed
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	A description for the permission scheme.
`description (anyOf 2)`	null	Alternative
`expand`	JSON	Optional
`expand (anyOf 1)`	string	Alternative	The expand options available for the permission scheme. Read only: true
`expand (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the permission scheme. 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 permission scheme. Must be unique.
`name (anyOf 2)`	null	Alternative
`permissions`	JSON	Optional
`permissions (anyOf 1)`	array	Alternative	The permission scheme to create or update. See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more information.
`permissions (anyOf 1)[]`	Model	Each item	Expand Create permission grant — response body
`permissions (anyOf 2)`	null	Alternative
`scope`	JSON	Optional
`scope (anyOf 1)`	Model	Alternative	Expand Get status — response body — scope project, type The scope of the permission scheme.
`scope (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the permission scheme. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative

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

Create permission grant — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a permission granted to a user or group. Additional keys: allowed
`holder`	JSON	Optional
`holder (anyOf 1)`	Model	Alternative	Expand Create permission grant — response body — holder expand, parameter, type, value The user or group being granted the permission. It consists of a `type`, a type-dependent `parameter` and a type-dependent `value`. See [Holder object](../api-group-permission-schemes/#holder-object) in Get all permission schemes for more information.
`holder (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the permission granted details. 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
`permission`	JSON	Optional
`permission (anyOf 1)`	string	Alternative	The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See [Built-in permissions](../api-group-permission-schemes/#built-in-permissions) in Get all permission schemes for more information about the built-in permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information about custom permissions.
`permission (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the permission granted details. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative

Referenced models: Create permission grant — response body — holder expand, parameter, type, value

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

Create permission grant — response body — holder expand, parameter, type, value

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a user, group, field, or project role that holds a permission. See [Holder object](../api-group-permission-schemes/#holder-object) in Get all permission schemes for more information.
`expand`	JSON	Optional
`expand (anyOf 1)`	string	Alternative	Expand options that include additional permission holder details in the response. Read only: true
`expand (anyOf 2)`	null	Alternative
`parameter`	JSON	Optional
`parameter (anyOf 1)`	string	Alternative	As a group's name can change, use of `value` is recommended. The identifier associated withthe `type` value that defines the holder of the permission.
`parameter (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of permission holder.
`type (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	The identifier associated with the `type` value that defines the holder of the permission.
`value (anyOf 2)`	null	Alternative

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

Policy, approvals and errors

SDK function policy ID: atlassian.assignpermissionscheme. Catalog operation: assignpermissionscheme. 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: ["manage:jira-project"]

Official provider source

Report an issue with this page