Atlassian: Add share permission

Atlassian filterSharing.addSharePermission: arguments, response, policy and SDK examples.

← Filter sharing operations · Get started

Operation atlassian.addsharepermission

Provider route: POST /{cloudId}/rest/api/3/filter/{id}/permission. 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["filterSharing"]["addSharePermission"]>[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.filterSharing.addSharePermission(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.filter_sharing.add_share_permission(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.id`	integer	Required within parent	Format: int64
`body`	Model	Required within parent	Expand Add share permission — request body — body

Referenced models: Add share permission — 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
`$`	array	Root
`$[]`	Model	Each item	Expand Get share permission — response body

Referenced models: Get share permission — response body

Schemas

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

Get share permission — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a share permission for the filter.
`group`	JSON	Optional
`group (anyOf 1)`	Model	Alternative	Expand Get user groups — response body — item The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended.
`group (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The unique identifier of the share permission. 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
`project`	JSON	Optional
`project (anyOf 1)`	Model	Alternative	Expand Get project — response body The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. For a request, specify the `id` for the project.
`project (anyOf 2)`	null	Alternative
`role`	JSON	Optional
`role (anyOf 1)`	Model	Alternative	Expand Create project role — response body The project role that the filter is shared with. For a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in.
`role (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of share permission: * `user` Shared with a user. * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well. * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well. * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`. * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified. * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`. * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request. Known values: user, group, project, projectRole, global, loggedin, authenticated, project-unknown
`type (anyOf 2)`	null	Alternative
`user`	JSON	Optional
`user (anyOf 1)`	Model	Alternative	Expand Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user.
`user (anyOf 2)`	null	Alternative

Referenced models: Get user groups — response body — item, Get project — response body, Create project role — response body, Get share permission — response body — user account Id, active, avatar Urls, display Name, key, name, self

Add share permission — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`accountId`	string	Optional	The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user.
`groupId`	string	Optional	The ID of the group, which uniquely identifies the group across all Atlassian products.For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2. Cannot be provided with `groupname`.
`groupname`	string	Optional	The name of the group to share the filter with. Set `type` to `group`. Please note that the name of a group is mutable, to reliably identify a group use `groupId`.
`projectId`	string	Optional	The ID of the project to share the filter with. Set `type` to `project`.
`projectRoleId`	string	Optional	The ID of the project role to share the filter with. Set `type` to `projectRole` and the `projectId` for the project that the role is in.
`rights`	integer	Optional	The rights for the share permission. Format: int32
`type`	string	Required within parent	The type of the share permission.Specify the type as follows: * `user` Share with a user. * `group` Share with a group. Specify `groupname` as well. * `project` Share with a project. Specify `projectId` as well. * `projectRole` Share with a project role in a project. Specify `projectId` and `projectRoleId` as well. * `global` Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set. * `authenticated` Share with all logged-in users. This shows as `loggedin` in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set. One of: user, project, group, projectRole, global, authenticated

Get user groups — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a group.
`groupId`	JSON	Optional
`groupId (anyOf 1)`	JSON	Alternative
`groupId (anyOf 1) (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 1) (anyOf 2)`	null	Alternative
`groupId (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of group.
`name (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL for these group details. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative

Create project role — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about the roles in a project.
`actors`	JSON	Optional
`actors (anyOf 1)`	array	Alternative	The list of users who act in this role. Read only: true
`actors (anyOf 1)[]`	Model	Each item	Expand Create project role — response body — actors The list of users who act in this role item
`actors (anyOf 2)`	null	Alternative
`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
`currentUserRole`	JSON	Optional
`currentUserRole (anyOf 1)`	boolean	Alternative	Whether the calling user is part of this role.
`currentUserRole (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

Referenced models: Create project role — response body — actors The list of users who act in this role item, Get status — response body — scope project, type

Get user — response body — groups callback, items, max-results, paging Callback, size callback object

Field	Type	Presence	Description and constraints
`$`	object	Root

Policy, approvals and errors

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

Official provider source

Report an issue with this page