POST /rest/api/2/filter/{id}/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.

Servers

https://your-domain.atlassian.net

Path parameters

Name	Type	Required	Description
`id`	Integer	Yes	The ID of the filter.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`projectId`	String	No	The ID of the project to share the filter with. Set `type` to `project`.
`groupId`	String	No	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`.
`accountId`	String	No	The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user.
`groupname`	String	No	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`.
`type`	String	Yes	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. Possible values: `"global"` `"project"` `"group"` `"projectRole"` `"user"` `"authenticated"`
`projectRoleId`	String	No	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	No	The rights for the share permission.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.