Add share permission

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/filter//permission' \ --header 'Content-Type: application/json' \ --data-raw '{ "groupname": "jira-administrators", "rights": 1, "type": "group" }'

[{"id":10000,"type":"global"},{"id":10010,"type":"project","project":{"self":"https://your-domain.atlassian.net/rest/api/3/project/EX","id":"10000","key":"EX","name":"Example","avatarUrls":{"48x48":"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000","24x24":"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000","16x16":"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000","32x32":"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000"},"projectCategory":{"self":"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000","id":"10000","name":"FIRST","description":"First Project Category"},"simplified":false,"style":"classic","insight":{"totalIssueCount":100,"lastIssueUpdateTime":"2023-07-12T06:03:00.831+0000"}}},{"id":10010,"type":"project","project":{"self":"https://your-domain.atlassian.net/rest/api/3/project/MKY","id":"10002","key":"MKY","name":"Example","avatarUrls":{"48x48":"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002","24x24":"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002","16x16":"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002","32x32":"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002"},"projectCategory":{"self":"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000","id":"10000","name":"FIRST","description":"First Project Category"},"simplified":false,"style":"classic","insight":{"totalIssueCount":100,"lastIssueUpdateTime":"2023-07-12T06:03:00.831+0000"},"deleted":true,"retentionTillDate":"2023-09-10T06:03:00.832+0000","deletedDate":"2023-07-12T06:03:00.832+0000","deletedBy":{"self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","key":"","accountId":"5b10a2844c20165700ede21g","accountType":"atlassian","name":"","avatarUrls":{"48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24","16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"},"displayName":"Mia Krystof","active":false}},"role":{"self":"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360","name":"Developers","id":10360,"description":"A project role that represents developers in a project","actors":[{"id":10240,"displayName":"jira-developers","type":"atlassian-group-role-actor","name":"jira-developers","actorGroup":{"name":"jira-developers","displayName":"jira-developers","groupId":"952d12c3-5b5b-4d04-bb32-44d383afc4b2"}},{"id":10241,"displayName":"Mia Krystof","type":"atlassian-user-role-actor","actorUser":{"accountId":"5b10a2844c20165700ede21g"}}],"scope":{"type":"PROJECT","project":{"id":"10000","key":"KEY","name":"Next Gen Project"}}}},{"id":10010,"type":"group","group":{"name":"jira-administrators","groupId":"276f955c-63d7-42c8-9520-92d01dca0625","self":"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"}}]

Request

Path Params

integer

required

The ID of the filter.

Body Params application/json

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 <int32>

optional

The rights for the share permission.

type

enum<string>

required

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.

Allowed values:

userprojectgroupprojectRoleglobalauthenticated

Examples

Responses

🟢201Returned if the request is successful.

application/json

Body

array of:

group

object

optional

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.

groupId

string | null

optional

The ID of the group, which uniquely identifies the group across all Atlassian products. For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2.

name

string

optional

The name of group.

self

string <uri>

read-onlyoptional

The URL for these group details.

integer <int64>

read-onlyoptional

The unique identifier of the share permission.

project

object

optional

The project that the filter is shared with. This is similar to the project object returned by Get project 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.

archived

boolean

read-onlyoptional

Whether the project is archived.

archivedBy

object

read-onlyoptional

The user who archived the project.

archivedDate

string <date-time>

read-onlyoptional

The date when the project was archived.

assigneeType

enum<string>

read-onlyoptional

The default assignee when creating issues for this project.

Allowed values:

PROJECT_LEADUNASSIGNED

avatarUrls

object

read-onlyoptional

The URLs of the project's avatars.

components

array[object (ProjectComponent) {13}]

read-onlyoptional

List of the components contained in the project.

deleted

boolean

read-onlyoptional

Whether the project is marked as deleted.

deletedBy

object

read-onlyoptional

The user who marked the project as deleted.

deletedDate

string <date-time>

read-onlyoptional

The date when the project was marked as deleted.

description

string

read-onlyoptional

A brief description of the project.

string

optional

An email address associated with the project.

expand

string

read-onlyoptional

Expand options that include additional project details in the response.

favourite

boolean

optional

Whether the project is selected as a favorite.

string

optional

The ID of the project.

insight

object

read-onlyoptional

Insights about the project.

isPrivate

boolean

read-onlyoptional

Whether the project is private.

issueTypeHierarchy

object

read-onlyoptional

The issue type hierarchy for the project.

issueTypes

array[object (IssueTypeDetails) {10}]

read-onlyoptional

List of the issue types available in the project.

key

string

read-onlyoptional

The key of the project.

landingPageInfo

object

read-onlyoptional

The project landing page info.

lead

object

read-onlyoptional

The username of the project lead.

name

string

read-onlyoptional

The name of the project.

permissions

object

read-onlyoptional

User permissions on the project

projectCategory

object

read-onlyoptional

The category the project belongs to.

projectTypeKey

enum<string>

read-onlyoptional

The project type of the project.

Allowed values:

softwareservice_deskbusiness

properties

object

read-onlyoptional

Map of project properties

retentionTillDate

string <date-time>

read-onlyoptional

The date when the project is deleted permanently.

roles

object

read-onlyoptional

The name and self URL for each role defined in the project. For more information, see Create project role.

self

string <uri>

read-onlyoptional

The URL of the project details.

simplified

boolean

read-onlyoptional

Whether the project is simplified.

style

enum<string>

read-onlyoptional

The type of the project.

Allowed values:

classicnext-gen

url

string

read-onlyoptional

A link to information about this project, such as project documentation.

uuid

string <uuid>

read-onlyoptional

Unique ID for next-gen projects.

versions

array[object (Version) {17}]

read-onlyoptional

The versions defined in the project. For more information, see Create version.

role

object

optional

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.

actors

array[object (RoleActor) {7}]

read-onlyoptional

The list of users who act in this role.

admin

boolean

read-onlyoptional

Whether this role is the admin role for the project.

currentUserRole

boolean

optional

Whether the calling user is part of this role.

default

boolean

read-onlyoptional

Whether this role is the default role for the project

description

string

read-onlyoptional

The description of the project role.

integer <int64>

read-onlyoptional

The ID of the project role.

name

string

optional

The name of the project role.

roleConfigurable

boolean

read-onlyoptional

Whether the roles are configurable for this project.

scope

object

read-onlyoptional

The scope of the role. Indicated for roles associated with next-gen projects.

self

string <uri>

read-onlyoptional

The URL the project role details.

translatedName

string

optional

The translated name of the project role.

type

enum<string>

required

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.

Allowed values:

usergroupprojectprojectRolegloballoggedinauthenticatedproject-unknown

user

object

optional

The user account ID that the filter is shared with. For a request, specify the accountId property for the user.

accountId

string

optional

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

<= 128 characters

active

boolean

optional

Whether the user is active.

avatarUrls

object

optional

The avatars of the user.

displayName

string

optional

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

key

string

optional

This property is deprecated in favor of accountId because of privacy changes. See the migration guide for details.
The key of the user.

name

string

optional

This property is deprecated in favor of accountId because of privacy changes. See the migration guide for details.
The username of the user.

self

string <uri>

optional

The URL of the user.

🟠400Returned if: * the request object is invalid. For example, it contains an invalid type, the ID does not match the type, or the project or group is not found. * the user does not own the filter. * the user does not have the required permissions.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if: * the filter is not found. * the user does not have permission to view the filter.