Sign in

v5

latestOpenAPI 3.0.1Apache 2.02026-08-046169702.3 MB
Filter sharing

Add share permission

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

post/rest/api/3/filter/{id}/permission

Path parameters

idinteger required

The ID of the filter.

Request body

accountIdstring

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

groupIdstring

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.

groupnamestring

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.

projectIdstring

The ID of the project to share the filter with. Set type to project.

projectRoleIdstring

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.

rightsinteger

The rights for the share permission.

type'user' | 'project' | 'group' | 'projectRole' | 'global' | 'authenticated' 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.

Response

Returned if the request is successful.

idinteger

The unique identifier of the share permission.

type'user' | 'group' | 'project' | 'projectRole' | 'global' | 'loggedin' | 'authenticated' | 'project-unknown' 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.