jira.js
    Preparing search index...

    Function findBulkAssignableUsers

    • Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.

      This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned issues in the projects. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned issues in the projects, use Get all users and filter the records in your code.

      Privacy controls are applied to the response based on the users' preferences. This could mean, for example, that the user's email address is hidden. See the Profile visibility overview for more details.

      This operation can be accessed anonymously.

      Permissions required: Browse Projects project permission for each project specified in projectKeys.

      Parameters

      • client: Client
      • parameters: {
            accountId?: string;
            maxResults?: number;
            projectKeys: string | string[];
            query?: string;
            startAt?: number;
        }
        • OptionalaccountId?: string

          A query string that is matched exactly against user accountId. Required, unless query is specified.

        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • projectKeys: string | string[]

          A list of project keys (case sensitive). This parameter accepts a comma-separated list.

        • Optionalquery?: string

          A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId is specified.

        • OptionalstartAt?: number

          The index of the first item to return in a page of results (page offset).

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              accountId?: string;
              accountType?: "unknown"
              | string & {}
              | "atlassian"
              | "app"
              | "customer";
              active?: boolean;
              applicationRoles?: {
                  callback?: { [key: string]: unknown };
                  items?: {
                      defaultGroups?: string[];
                      defaultGroupsDetails?: {
                          groupId?: ...;
                          name?: ...;
                          self?: ...;
                          [key: ...]: ...;
                      }[];
                      defined?: boolean;
                      groupDetails?: {
                          groupId?: ...;
                          name?: ...;
                          self?: ...;
                          [key: ...]: ...;
                      }[];
                      groups?: string[];
                      hasUnlimitedSeats?: boolean;
                      key?: string;
                      name?: string;
                      numberOfSeats?: number;
                      platform?: boolean;
                      remainingSeats?: number;
                      selectedByDefault?: boolean;
                      userCount?: number;
                      userCountDescription?: string;
                      [key: string]: unknown;
                  }[];
                  "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?: string | null;
                      name?: string;
                      self?: string;
                      [key: string]: unknown;
                  }[];
                  "max-results"?: number;
                  pagingCallback?: { [key: string]: unknown };
                  size?: number;
                  [key: string]: unknown;
              };
              guest?: boolean;
              locale?: string;
              self?: string;
              timeZone?: string;
              [key: string]: unknown;
          }[],
      >

    Settings
    Member Visibility