Skip to content

Function: getSharePermissions() ​

ts
function getSharePermissions(
   client, 
   parameters, 
   options?
): Promise<object[]>;

Defined in: src/cloud/api/filterSharing.ts:68

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.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ id: number; }-
parameters.idnumberThe ID of the filter.
options?RequestOptions-

Returns ​

Promise<object[]>