jira.js
    Preparing search index...

    Function getAllUsers

    • Returns a list of all users, including active users, inactive users and previously deleted users that have an Atlassian account.

      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.

      Parameters

      • client: Client
      • Optionalparameters: { expand?: string; maxResults?: number; startAt?: number }
        • Optionalexpand?: string
        • OptionalmaxResults?: number

          The maximum number of items to return (limited to 1000).

        • OptionalstartAt?: number

          The index of the first item to return.

      • 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