Sign in

v4

OpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Filter sharing

Get share permissions

Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

This operation can be accessed anonymously.

Permissions required: None, however, share permissions are only returned for:

  • filters owned by the user.
  • filters shared with a group that the user is a member of.
  • filters shared with a private project that the user has Browse projects project permission for.
  • filters shared with a public project.
  • filters shared with the public.
get/rest/api/3/filter/{id}/permission

Path parameters

idinteger required

The ID of the filter.

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.