jira.js
    Preparing search index...

    Function findUsersAndGroups

    • Returns a list of users and groups matching query with highlighting

      Parameters

      • client: Client
      • Optionalparameters: {
            fieldId?: string;
            issueTypeId?: string;
            maxResults?: string;
            projectId?: string;
            query?: string;
            showAvatar?: string;
        }
        • OptionalfieldId?: string

          The custom field id

        • OptionalissueTypeId?: string

          The list of issue type ids to further restrict the search

        • OptionalmaxResults?: string

          The maximum number of users to return

        • OptionalprojectId?: string

          The list of project ids to further restrict the search

        • Optionalquery?: string

          A string used to search username, Name or e-mail address

        • OptionalshowAvatar?: string

          Show avatar

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              groups?: {
                  groups?: {
                      html?: string;
                      labels?: {
                          text?: (...)
                          | (...);
                          title?: (...) | (...);
                          type?: (...) | (...) | (...) | (...) | (...);
                          [key: string]: unknown;
                      }[];
                      name?: string;
                      [key: string]: unknown;
                  }[];
                  header?: string;
                  total?: number;
                  [key: string]: unknown;
              };
              users?: {
                  header?: string;
                  total?: number;
                  users?: {
                      avatarUrl?: string;
                      displayName?: string;
                      html?: string;
                      key?: string;
                      name?: string;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility