jira.js
    Preparing search index...

    Function findUsers

    • Finds users.

      Parameters

      • client: Client
      • Optionalparameters: {
            includeActive?: boolean;
            includeInactive?: boolean;
            maxResults?: number;
            startAt?: number;
            username?: string;
        }
        • OptionalincludeActive?: boolean

          If true, then active users are included in the results (default true)

        • OptionalincludeInactive?: boolean

          If true, then inactive users are included in the results (default false)

        • OptionalmaxResults?: number

          The maximum number of users to return (defaults to 50). The maximum allowed value is 100 (The combination of maxResults and startAt is limited to the first 100 results). If you specify a value that is higher than this number, your search results will be truncated. If you send a request with startAt=98 and maxResults=20, it will only return 2 users.

        • OptionalstartAt?: number

          The index of the first user to return (0-based). Please note that the startAt parameter will be deprecated in a future release of Jira 10.3.x

        • Optionalusername?: string

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

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              active?: boolean;
              applicationRoles?: {
                  callback?: { [key: string]: unknown };
                  maxResults?: number;
                  pagingCallback?: { [key: string]: unknown };
                  size?: number;
                  [key: string]: unknown;
              };
              avatarUrls?: Record<string, string>;
              deleted?: boolean;
              displayName?: string;
              emailAddress?: string;
              expand?: string;
              groups?: {
                  callback?: { [key: string]: unknown };
                  maxResults?: number;
                  pagingCallback?: { [key: string]: unknown };
                  size?: number;
                  [key: string]: unknown;
              };
              key?: string;
              lastLoginTime?: string;
              locale?: string;
              name?: string;
              self?: string;
              timeZone?: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility