jira.js
    Preparing search index...

    Function getSharePermission

    • 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

      • client: Client
      • parameters: { id: number; permissionId: number }
        • id: number

          The ID of the filter.

        • permissionId: number

          The ID of the share permission.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              group?: {
                  groupId?: string
                  | null;
                  name?: string;
                  self?: string;
                  [key: string]: unknown;
              };
              id?: number;
              project?: {
                  archived?: boolean;
                  archivedBy?: {
                      accountId?: string;
                      accountType?: "unknown"
                      | string & {}
                      | "atlassian"
                      | "app"
                      | "customer";
                      active?: boolean;
                      applicationRoles?: {
                          callback?: { [key: string]: unknown };
                          items?: {
                              defaultGroups?: ...;
                              defaultGroupsDetails?: ...;
                              defined?: ...;
                              groupDetails?: ...;
                              groups?: ...;
                              hasUnlimitedSeats?: ...;
                              key?: ...;
                              name?: ...;
                              numberOfSeats?: ...;
                              platform?: ...;
                              remainingSeats?: ...;
                              selectedByDefault?: ...;
                              userCount?: ...;
                              userCountDescription?: ...;
                              [key: ...]: ...;
                          }[];
                          "max-results"?: number;
                          pagingCallback?: { [key: string]: unknown };
                          size?: number;
                          [key: string]: unknown;
                      };
                      appType?: string;
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      emailAddress?: string;
                      expand?: string;
                      groups?: {
                          callback?: { [key: string]: unknown };
                          items?: { groupId?: ...; name?: ...; self?: ...; [key: ...]: ... }[];
                          "max-results"?: number;
                          pagingCallback?: { [key: string]: unknown };
                          size?: number;
                          [key: string]: unknown;
                      };
                      guest?: boolean;
                      locale?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  };
                  archivedDate?: Date;
                  assigneeType?: string & {}
                  | "PROJECT_LEAD"
                  | "UNASSIGNED";
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  components?: {
                      ari?: string;
                      assignee?: {
                          accountId?: string;
                          accountType?: | "unknown"
                          | (...) & (...)
                          | "atlassian"
                          | "app"
                          | "customer";
                          active?: boolean;
                          applicationRoles?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          appType?: string;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          emailAddress?: string;
                          expand?: string;
                          groups?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          guest?: boolean;
                          locale?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      assigneeType?: | string & {}
                      | "PROJECT_DEFAULT"
                      | "COMPONENT_LEAD"
                      | "PROJECT_LEAD"
                      | "UNASSIGNED";
                      description?: string;
                      id?: string;
                      isAssigneeTypeValid?: boolean;
                      lead?: {
                          accountId?: string;
                          accountType?: | "unknown"
                          | (...) & (...)
                          | "atlassian"
                          | "app"
                          | "customer";
                          active?: boolean;
                          applicationRoles?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          appType?: string;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          emailAddress?: string;
                          expand?: string;
                          groups?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          guest?: boolean;
                          locale?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      leadAccountId?: string;
                      metadata?: Record<string, any>;
                      name?: string;
                      project?: string;
                      projectId?: number;
                      realAssignee?: {
                          accountId?: string;
                          accountType?:
                              | "unknown"
                              | (...) & (...)
                              | "atlassian"
                              | "app"
                              | "customer";
                          active?: boolean;
                          applicationRoles?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          appType?: string;
                          avatarUrls?: {
                              "16x16"?: ...;
                              "24x24"?: ...;
                              "32x32"?: ...;
                              "48x48"?: ...;
                              [key: ...]: ...;
                          };
                          displayName?: string;
                          emailAddress?: string;
                          expand?: string;
                          groups?: {
                              callback?: ...;
                              items?: ...;
                              "max-results"?: ...;
                              pagingCallback?: ...;
                              size?: ...;
                              [key: ...]: ...;
                          };
                          guest?: boolean;
                          locale?: string;
                          self?: string;
                          timeZone?: string;
                          [key: string]: unknown;
                      };
                      realAssigneeType?: | string & {}
                      | "PROJECT_DEFAULT"
                      | "COMPONENT_LEAD"
                      | "PROJECT_LEAD"
                      | "UNASSIGNED";
                      self?: string;
                      [key: string]: unknown;
                  }[];
                  deleted?: boolean;
                  deletedBy?: {
                      accountId?: string;
                      accountType?: "unknown"
                      | string & {}
                      | "atlassian"
                      | "app"
                      | "customer";
                      active?: boolean;
                      applicationRoles?: {
                          callback?: { [key: string]: unknown };
                          items?: {
                              defaultGroups?: ...;
                              defaultGroupsDetails?: ...;
                              defined?: ...;
                              groupDetails?: ...;
                              groups?: ...;
                              hasUnlimitedSeats?: ...;
                              key?: ...;
                              name?: ...;
                              numberOfSeats?: ...;
                              platform?: ...;
                              remainingSeats?: ...;
                              selectedByDefault?: ...;
                              userCount?: ...;
                              userCountDescription?: ...;
                              [key: ...]: ...;
                          }[];
                          "max-results"?: number;
                          pagingCallback?: { [key: string]: unknown };
                          size?: number;
                          [key: string]: unknown;
                      };
                      appType?: string;
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      emailAddress?: string;
                      expand?: string;
                      groups?: {
                          callback?: { [key: string]: unknown };
                          items?: { groupId?: ...; name?: ...; self?: ...; [key: ...]: ... }[];
                          "max-results"?: number;
                          pagingCallback?: { [key: string]: unknown };
                          size?: number;
                          [key: string]: unknown;
                      };
                      guest?: boolean;
                      locale?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  };
                  deletedDate?: Date;
                  description?: string;
                  email?: string;
                  entityId?: string;
                  expand?: string;
                  favourite?: boolean;
                  id?: string;
                  insight?: {
                      lastIssueUpdateTime?: Date;
                      totalIssueCount?: number;
                      [key: string]: unknown;
                  };
                  isPrivate?: boolean;
                  issueTypeHierarchy?: {
                      levels?: {
                          hierarchyLevelNumber?: number;
                          issueTypeIds?: (...)[];
                          level?: number;
                          name?: string;
                          [key: string]: unknown;
                      }[];
                      [key: string]: unknown;
                  };
                  issueTypes?: {
                      avatarId?: number;
                      description?: string;
                      entityId?: string;
                      hierarchyLevel?: number;
                      iconUrl?: string;
                      id?: string;
                      name?: string;
                      scope?: {
                          project?: {
                              avatarUrls?: ...;
                              id?: ...;
                              key?: ...;
                              name?: ...;
                              projectCategory?: ...;
                              projectTypeKey?: ...;
                              self?: ...;
                              simplified?: ...;
                              [key: ...]: ...;
                          };
                          type?: (...) & (...)
                          | "PROJECT"
                          | "TEMPLATE";
                          [key: string]: unknown;
                      };
                      self?: string;
                      subtask?: boolean;
                      untranslatedName?: string;
                      [key: string]: unknown;
                  }[];
                  key?: string;
                  landingPageInfo?: {
                      attributes?: Record<string, any>;
                      boardId?: number;
                      boardName?: string;
                      projectKey?: string;
                      projectType?: string;
                      queueCategory?: string;
                      queueId?: number;
                      queueName?: string;
                      simpleBoard?: boolean;
                      simplified?: boolean;
                      url?: string;
                      [key: string]: unknown;
                  };
                  lead?: {
                      accountId?: string;
                      accountType?: "unknown"
                      | string & {}
                      | "atlassian"
                      | "app"
                      | "customer";
                      active?: boolean;
                      applicationRoles?: {
                          callback?: { [key: string]: unknown };
                          items?: {
                              defaultGroups?: ...;
                              defaultGroupsDetails?: ...;
                              defined?: ...;
                              groupDetails?: ...;
                              groups?: ...;
                              hasUnlimitedSeats?: ...;
                              key?: ...;
                              name?: ...;
                              numberOfSeats?: ...;
                              platform?: ...;
                              remainingSeats?: ...;
                              selectedByDefault?: ...;
                              userCount?: ...;
                              userCountDescription?: ...;
                              [key: ...]: ...;
                          }[];
                          "max-results"?: number;
                          pagingCallback?: { [key: string]: unknown };
                          size?: number;
                          [key: string]: unknown;
                      };
                      appType?: string;
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      emailAddress?: string;
                      expand?: string;
                      groups?: {
                          callback?: { [key: string]: unknown };
                          items?: { groupId?: ...; name?: ...; self?: ...; [key: ...]: ... }[];
                          "max-results"?: number;
                          pagingCallback?: { [key: string]: unknown };
                          size?: number;
                          [key: string]: unknown;
                      };
                      guest?: boolean;
                      locale?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  };
                  name?: string;
                  permissions?: { canEdit?: boolean; [key: string]: unknown };
                  projectCategory?: {
                      description?: string;
                      id?: string;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  };
                  projectTypeKey?: | string & {}
                  | "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 & {} | "next-gen";
                  url?: string;
                  uuid?: string;
                  versions?: {
                      approvers?: {
                          accountId?: (...) | (...);
                          declineReason?: (...) | (...);
                          description?: (...) | (...);
                          status?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      archived?: boolean;
                      description?: string;
                      driver?: string;
                      expand?: string;
                      id?: string;
                      issuesStatusForFixVersion?: {
                          done?: number;
                          inProgress?: number;
                          toDo?: number;
                          unmapped?: number;
                          [key: string]: unknown;
                      };
                      moveUnfixedIssuesTo?: string;
                      name?: string;
                      operations?: {
                          href?: (...)
                          | (...);
                          iconClass?: (...) | (...);
                          id?: (...) | (...);
                          label?: (...) | (...);
                          styleClass?: (...) | (...);
                          title?: (...) | (...);
                          weight?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      overdue?: boolean;
                      projectId?: number;
                      released?: boolean;
                      releaseDate?: string;
                      self?: string;
                      startDate?: string;
                      userReleaseDate?: string;
                      userStartDate?: string;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              role?: {
                  actors?: {
                      actorGroup?: {
                          displayName?: string;
                          groupId?: string;
                          name?: string;
                          [key: string]: unknown;
                      };
                      actorUser?: { accountId?: string; [key: string]: unknown };
                      avatarUrl?: string;
                      displayName?: string;
                      id?: number;
                      type?:
                          | string & {}
                          | "atlassian-group-role-actor"
                          | "atlassian-user-role-actor";
                      [key: string]: unknown;
                  }[];
                  admin?: boolean;
                  currentUserRole?: boolean;
                  default?: boolean;
                  description?: string;
                  id?: number;
                  name?: string;
                  roleConfigurable?: boolean;
                  scope?: {
                      project?: {
                          avatarUrls?: {
                              "16x16"?: (...)
                              | (...);
                              "24x24"?: (...) | (...);
                              "32x32"?: (...) | (...);
                              "48x48"?: (...) | (...);
                              [key: string]: unknown;
                          };
                          id?: string;
                          key?: string;
                          name?: string;
                          projectCategory?: {
                              description?: (...)
                              | (...);
                              id?: (...) | (...);
                              name?: (...) | (...);
                              self?: (...) | (...);
                              [key: string]: unknown;
                          };
                          projectTypeKey?: | string & {}
                          | "software"
                          | "service_desk"
                          | "business"
                          | "product_discovery"
                          | "customer_service";
                          self?: string;
                          simplified?: boolean;
                          [key: string]: unknown;
                      };
                      type?: string & {}
                      | "PROJECT"
                      | "TEMPLATE";
                      [key: string]: unknown;
                  };
                  self?: string;
                  translatedName?: string;
                  [key: string]: unknown;
              };
              type: | "global"
              | "user"
              | "group"
              | string & {}
              | "project"
              | "projectRole"
              | "loggedin"
              | "authenticated"
              | "project-unknown";
              user?: {
                  accountId?: string;
                  active?: boolean;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  self?: string;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility