jira.js
    Preparing search index...

    Function findAssignableUsers

    • Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:

      • A new issue, by providing the projectKeyOrId.
      • An updated issue, by providing the issueKey or issueId.
      • To an issue during a transition (workflow action), by providing the issueKey or issueId and the transition id in actionDescriptorId. You can obtain the IDs of an issue's valid transitions using the transitions option in the expand parameter of Get issue.

      In all these cases, you can pass an account ID to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition.

      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 the issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned the issue, 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.

      Permissions required: Browse users and groups global permission or Assign issues project permission

      Parameters

      • client: Client
      • Optionalparameters: {
            accountId?: string;
            accountType?: string[];
            actionDescriptorId?: number;
            appType?: string[];
            issueId?: string;
            issueKey?: string;
            maxResults?: number;
            project?: string;
            query?: string;
            recommend?: boolean;
            sessionId?: string;
            startAt?: number;
        }
        • OptionalaccountId?: string

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

        • OptionalaccountType?: string[]
        • OptionalactionDescriptorId?: number

          The ID of the transition.

        • OptionalappType?: string[]
        • OptionalissueId?: string

          The ID of the issue. Required, unless issueKey or project is specified.

        • OptionalissueKey?: string

          The key of the issue. Required, unless issueId or project is specified.

        • OptionalmaxResults?: number

          The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue.

        • Optionalproject?: string

          The project ID or project key (case sensitive). Required, unless issueKey or issueId is specified.

        • 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 username or accountId is specified.

        • Optionalrecommend?: boolean
        • OptionalsessionId?: string

          The sessionId of this request. SessionId is the same until the assignee is set.

        • 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