Atlassian: Create permission scheme

Atlassian permissionSchemes.createPermissionScheme: arguments, response, policy and SDK examples.

← Permission schemes operations · Get started

Operation atlassian.createpermissionscheme

Provider route: POST /{cloudId}/rest/api/3/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["permissionSchemes"]["createPermissionScheme"]>[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.permissionSchemes.createPermissionScheme(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.permission_schemes.create_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}$
`query`	object	Optional	Additional keys: not allowed
`query.expand`	string	Optional
`body`	Model	Required within parent	Expand Create permission scheme — request body — body

Referenced models: Create 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

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

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 scheme — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a permission scheme. Additional keys: allowed
`description`	string	Optional	A description for the permission scheme.
`expand`	string	Optional	The expand options available for the permission scheme. Read only: true
`id`	integer	Optional	The ID of the permission scheme. Format: int64 Read only: true
`name`	string	Required within parent	The name of the permission scheme. Must be unique.
`permissions`	array	Optional	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[]`	Model	Each item	Expand Create permission grant — request body — body
`scope`	Model	Optional	Expand Create permission scheme — request body — body scope The scope of the permission scheme.
`self`	string	Optional	The URL of the permission scheme. Format: uri Read only: true

Referenced models: Create permission grant — request body — body, Create permission scheme — request body — body scope

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 — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a permission granted to a user or group. Additional keys: allowed
`holder`	Model	Optional	Expand Create permission grant — request body — body holder 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.
`id`	integer	Optional	The ID of the permission granted details. Format: int64 Read only: true
`permission`	string	Optional	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.
`self`	string	Optional	The URL of the permission granted details. Format: uri Read only: true

Referenced models: Create permission grant — request body — body holder

Create permission scheme — request body — body scope

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`	Model	Optional	Expand Create permission scheme — request body — body scope project The project the item has scope in. Read only: true
`type`	string	Optional	The type of scope. One of: PROJECT, TEMPLATE Read only: true

Referenced models: Create permission scheme — request body — body scope project

Create permission grant — request body — body holder

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. Additional keys: not allowed
`expand`	string	Optional	Expand options that include additional permission holder details in the response. Read only: true
`parameter`	string	Optional	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.
`type`	string	Required within parent	The type of permission holder.
`value`	string	Optional	The identifier associated with the `type` value that defines the holder of the permission.

Policy, approvals and errors

SDK function policy ID: atlassian.createpermissionscheme. Catalog operation: createpermissionscheme. 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-configuration"]

Official provider source

Report an issue with this page