Function: getSharePermission()

function getSharePermission(client, parameters): Promise<{
[key: string]: unknown;
  group?: {
   [key: string]: unknown;
     groupId?: string | null;
     name?: string;
     self?: string;
  };
  id?: number;
  project?: {
   [key: string]: unknown;
     archived?: boolean;
     archivedBy?: {
      [key: string]: unknown;
        accountId?: string;
        accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
        active?: boolean;
        applicationRoles?: {
         [key: string]: unknown;
           callback?: {
            [key: string]: unknown;
           };
           items?: object[];
           max-results?: number;
           pagingCallback?: {
            [key: string]: unknown;
           };
           size?: number;
        };
        appType?: string;
        avatarUrls?: {
         [key: string]: unknown;
           16x16?: string;
           24x24?: string;
           32x32?: string;
           48x48?: string;
        };
        displayName?: string;
        emailAddress?: string;
        expand?: string;
        groups?: {
         [key: string]: unknown;
           callback?: {
            [key: string]: unknown;
           };
           items?: object[];
           max-results?: number;
           pagingCallback?: {
            [key: string]: unknown;
           };
           size?: number;
        };
        guest?: boolean;
        locale?: string;
        self?: string;
        timeZone?: string;
     };
     archivedDate?: Date;
     assigneeType?: string & object | "PROJECT_LEAD" | "UNASSIGNED";
     avatarUrls?: {
      [key: string]: unknown;
        16x16?: string;
        24x24?: string;
        32x32?: string;
        48x48?: string;
     };
     components?: object[];
     deleted?: boolean;
     deletedBy?: {
      [key: string]: unknown;
        accountId?: string;
        accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
        active?: boolean;
        applicationRoles?: {
         [key: string]: unknown;
           callback?: {
            [key: string]: unknown;
           };
           items?: object[];
           max-results?: number;
           pagingCallback?: {
            [key: string]: unknown;
           };
           size?: number;
        };
        appType?: string;
        avatarUrls?: {
         [key: string]: unknown;
           16x16?: string;
           24x24?: string;
           32x32?: string;
           48x48?: string;
        };
        displayName?: string;
        emailAddress?: string;
        expand?: string;
        groups?: {
         [key: string]: unknown;
           callback?: {
            [key: string]: unknown;
           };
           items?: object[];
           max-results?: number;
           pagingCallback?: {
            [key: string]: unknown;
           };
           size?: number;
        };
        guest?: boolean;
        locale?: string;
        self?: string;
        timeZone?: string;
     };
     deletedDate?: Date;
     description?: string;
     email?: string;
     entityId?: string;
     expand?: string;
     favourite?: boolean;
     id?: string;
     insight?: {
      [key: string]: unknown;
        lastIssueUpdateTime?: Date;
        totalIssueCount?: number;
     };
     isPrivate?: boolean;
     issueTypeHierarchy?: {
      [key: string]: unknown;
        levels?: object[];
     };
     issueTypes?: object[];
     key?: string;
     landingPageInfo?: {
      [key: string]: unknown;
        attributes?: Record<string, any>;
        boardId?: number;
        boardName?: string;
        projectKey?: string;
        projectType?: string;
        queueCategory?: string;
        queueId?: number;
        queueName?: string;
        simpleBoard?: boolean;
        simplified?: boolean;
        url?: string;
     };
     lead?: {
      [key: string]: unknown;
        accountId?: string;
        accountType?: "unknown" | string & object | "atlassian" | "app" | "customer";
        active?: boolean;
        applicationRoles?: {
         [key: string]: unknown;
           callback?: {
            [key: string]: unknown;
           };
           items?: object[];
           max-results?: number;
           pagingCallback?: {
            [key: string]: unknown;
           };
           size?: number;
        };
        appType?: string;
        avatarUrls?: {
         [key: string]: unknown;
           16x16?: string;
           24x24?: string;
           32x32?: string;
           48x48?: string;
        };
        displayName?: string;
        emailAddress?: string;
        expand?: string;
        groups?: {
         [key: string]: unknown;
           callback?: {
            [key: string]: unknown;
           };
           items?: object[];
           max-results?: number;
           pagingCallback?: {
            [key: string]: unknown;
           };
           size?: number;
        };
        guest?: boolean;
        locale?: string;
        self?: string;
        timeZone?: string;
     };
     name?: string;
     permissions?: {
      [key: string]: unknown;
        canEdit?: boolean;
     };
     projectCategory?: {
      [key: string]: unknown;
        description?: string;
        id?: string;
        name?: string;
        self?: string;
     };
     projectTypeKey?:   | string & object
        | "software"
        | "service_desk"
        | "business"
        | "product_discovery"
        | "customer_service";
     properties?: Record<string, any>;
     retentionTillDate?: Date;
     roles?: Record<string, any>;
     self?: string;
     simplified?: boolean;
     style?: "classic" | string & object | "next-gen";
     url?: string;
     uuid?: string;
     versions?: object[];
  };
  role?: {
   [key: string]: unknown;
     actors?: object[];
     admin?: boolean;
     currentUserRole?: boolean;
     default?: boolean;
     description?: string;
     id?: number;
     name?: string;
     roleConfigurable?: boolean;
     scope?: {
      [key: string]: unknown;
        project?: {
         [key: string]: unknown;
           avatarUrls?: {
            [key: string]: unknown;
              16x16?: ... | ...;
              24x24?: ... | ...;
              32x32?: ... | ...;
              48x48?: ... | ...;
           };
           id?: string;
           key?: string;
           name?: string;
           projectCategory?: {
            [key: string]: unknown;
              description?: ... | ...;
              id?: ... | ...;
              name?: ... | ...;
              self?: ... | ...;
           };
           projectTypeKey?:   | string & object
              | "software"
              | "service_desk"
              | "business"
              | "product_discovery"
              | "customer_service";
           self?: string;
           simplified?: boolean;
        };
        type?: string & object | "PROJECT" | "TEMPLATE";
     };
     self?: string;
     translatedName?: string;
  };
  type:   | "global"
     | "user"
     | "group"
     | string & object
     | "project"
     | "projectRole"
     | "loggedin"
     | "authenticated"
     | "project-unknown";
  user?: {
   [key: string]: unknown;
     accountId?: string;
     active?: boolean;
     avatarUrls?: {
      [key: string]: unknown;
        16x16?: string;
        24x24?: string;
        32x32?: string;
        48x48?: string;
     };
     displayName?: string;
     self?: string;
  };
}>;

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

Returns a share permission 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, a share permission is 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

Parameter	Type	Description
client	Client	-
parameters	{ id: number; permissionId: number; }	-
parameters.id	number	The ID of the filter.
parameters.permissionId	number	The ID of the share permission.

Returns

Promise<{ [key: string]: unknown; group?: { [key: string]: unknown; groupId?: string | null; name?: string; self?: string; }; id?: number; project?: { [key: string]: unknown; archived?: boolean; archivedBy?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; appType?: string; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; archivedDate?: Date; assigneeType?: string & object | "PROJECT_LEAD" | "UNASSIGNED"; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; components?: object[]; deleted?: boolean; deletedBy?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; appType?: string; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; deletedDate?: Date; description?: string; email?: string; entityId?: string; expand?: string; favourite?: boolean; id?: string; insight?: { [key: string]: unknown; lastIssueUpdateTime?: Date; totalIssueCount?: number; }; isPrivate?: boolean; issueTypeHierarchy?: { [key: string]: unknown; levels?: object[]; }; issueTypes?: object[]; key?: string; landingPageInfo?: { [key: string]: unknown; attributes?: Record<string, any>; boardId?: number; boardName?: string; projectKey?: string; projectType?: string; queueCategory?: string; queueId?: number; queueName?: string; simpleBoard?: boolean; simplified?: boolean; url?: string; }; lead?: { [key: string]: unknown; accountId?: string; accountType?: "unknown" | string & object | "atlassian" | "app" | "customer"; active?: boolean; applicationRoles?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; appType?: string; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; emailAddress?: string; expand?: string; groups?: { [key: string]: unknown; callback?: { [key: string]: unknown; }; items?: object[]; max-results?: number; pagingCallback?: { [key: string]: unknown; }; size?: number; }; guest?: boolean; locale?: string; self?: string; timeZone?: string; }; name?: string; permissions?: { [key: string]: unknown; canEdit?: boolean; }; projectCategory?: { [key: string]: unknown; description?: string; id?: string; name?: string; self?: string; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; properties?: Record<string, any>; retentionTillDate?: Date; roles?: Record<string, any>; self?: string; simplified?: boolean; style?: "classic" | string & object | "next-gen"; url?: string; uuid?: string; versions?: object[]; }; role?: { [key: string]: unknown; actors?: object[]; admin?: boolean; currentUserRole?: boolean; default?: boolean; description?: string; id?: number; name?: string; roleConfigurable?: boolean; scope?: { [key: string]: unknown; project?: { [key: string]: unknown; avatarUrls?: { [key: string]: unknown; 16x16?: ... | ...; 24x24?: ... | ...; 32x32?: ... | ...; 48x48?: ... | ...; }; id?: string; key?: string; name?: string; projectCategory?: { [key: string]: unknown; description?: ... | ...; id?: ... | ...; name?: ... | ...; self?: ... | ...; }; projectTypeKey?: | string & object | "software" | "service_desk" | "business" | "product_discovery" | "customer_service"; self?: string; simplified?: boolean; }; type?: string & object | "PROJECT" | "TEMPLATE"; }; self?: string; translatedName?: string; }; type: | "global" | "user" | "group" | string & object | "project" | "projectRole" | "loggedin" | "authenticated" | "project-unknown"; user?: { [key: string]: unknown; accountId?: string; active?: boolean; avatarUrls?: { [key: string]: unknown; 16x16?: string; 24x24?: string; 32x32?: string; 48x48?: string; }; displayName?: string; self?: string; }; }>