jira.js
    Preparing search index...

    Function getUsersFromGroup

    • Returns a paginated list of all users in a group.

      Note that users are ordered by username, however the username is not returned in the results due to privacy reasons.

      Permissions required: either of:

      Parameters

      • client: Client
      • Optionalparameters: {
            groupId?: string;
            groupname?: string;
            includeInactiveUsers?: boolean;
            maxResults?: number;
            startAt?: number;
        }
        • OptionalgroupId?: string

          The ID of the group. This parameter cannot be used with the groupName parameter.

        • Optionalgroupname?: string

          As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter.

        • OptionalincludeInactiveUsers?: boolean

          Include inactive users.

        • OptionalmaxResults?: number

          The maximum number of items to return per page (number should be between 1 and 50).

        • OptionalstartAt?: number

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

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              maxResults: number;
              nextPage?: string;
              self?: string;
              startAt: number;
              total: number;
              values: {
                  accountId?: string;
                  accountType?: string;
                  active?: boolean;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility