jira.js
    Preparing search index...

    Function findUsersAndGroups

    • Returns a list of users and groups matching a string. The string is used:

      • For users, to find a case-insensitive match with display name and e-mail address. Note that if a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.
      • For groups, to find a case-sensitive match with group name.

      For example, if the string tin is used, records with the display name Tina, email address sarah@tinplatetraining.com, and the group accounting would be returned.

      Optionally, the search can be refined to:

      • The projects and issue types associated with a custom field, such as a user picker. The search can then be further refined to return only users and groups that have permission to view specific:

        • Projects.
        • Issue types.

        If multiple projects or issue types are specified, they must be a subset of those enabled for the custom field or no results are returned. For example, if a field is enabled for projects A, B, and C then the search could be limited to projects B and C. However, if the search is limited to projects B and D, nothing is returned.

      • Not return Connect app users and groups.

      • Return groups that have a case-insensitive match with the query.

      The primary use case for this resource is to populate a picker field suggestion list with users or groups. To this end, the returned object includes an html field for each list. This field highlights the matched query term in the item name with the HTML strong tag. Also, each list is wrapped in a response object that contains a header for use in a picker, specifically Showing X of Y matching groups.

      This operation can be accessed anonymously.

      Permissions required: Browse users and groups global permission.

      Parameters

      • client: Client
      • parameters: {
            avatarSize?:
                | "small"
                | "medium"
                | string & {}
                | "xsmall"
                | "large"
                | "xlarge"
                | "xsmall@2x"
                | "xsmall@3x"
                | "small@2x"
                | "small@3x"
                | "medium@2x"
                | "medium@3x"
                | "large@2x"
                | "large@3x"
                | "xlarge@2x"
                | "xlarge@3x"
                | "xxlarge"
                | "xxlarge@2x"
                | "xxlarge@3x"
                | "xxxlarge"
                | "xxxlarge@2x"
                | "xxxlarge@3x";
            caseInsensitive?: boolean;
            excludeConnectAddons?: boolean;
            fieldId?: string;
            includeAiAgents?: boolean;
            issueTypeId?: string[];
            maxResults?: number;
            projectId?: string[];
            query: string;
            showAvatar?: boolean;
        }
        • OptionalavatarSize?:
              | "small"
              | "medium"
              | string & {}
              | "xsmall"
              | "large"
              | "xlarge"
              | "xsmall@2x"
              | "xsmall@3x"
              | "small@2x"
              | "small@3x"
              | "medium@2x"
              | "medium@3x"
              | "large@2x"
              | "large@3x"
              | "xlarge@2x"
              | "xlarge@3x"
              | "xxlarge"
              | "xxlarge@2x"
              | "xxlarge@3x"
              | "xxxlarge"
              | "xxxlarge@2x"
              | "xxxlarge@3x"

          The size of the avatar to return. If an invalid value is provided, the default value is used.

        • OptionalcaseInsensitive?: boolean

          Whether the search for groups should be case insensitive.

        • OptionalexcludeConnectAddons?: boolean

          Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used.

        • OptionalfieldId?: string

          The custom field ID of the field this request is for.

        • OptionalincludeAiAgents?: boolean

          Whether AI Agents should be included in the search results. If an invalid value is provided, the default value is used.

        • OptionalissueTypeId?: string[]

          The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, issueTypeId=10000&issueTypeId=10001. Special values, such as -1 (all standard issue types) and -2 (all subtask issue types), are supported. This parameter is only used when fieldId is present.

        • OptionalmaxResults?: number

          The maximum number of items to return in each list.

        • OptionalprojectId?: string[]

          The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, projectId=10000&projectId=10001. This parameter is only used when fieldId is present.

        • query: string

          The search string.

        • OptionalshowAvatar?: boolean

          Whether the user avatar should be returned. If an invalid value is provided, the default value is used.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              groups?: {
                  groups?: {
                      avatarUrl?: string;
                      groupId?: string;
                      html?: string;
                      labels?: {
                          text?: (...)
                          | (...);
                          title?: (...) | (...);
                          type?: (...) | (...) | (...) | (...) | (...);
                          [key: string]: unknown;
                      }[];
                      managedBy?: | string & {}
                      | "EXTERNAL"
                      | "ADMINS"
                      | "TEAM_MEMBERS"
                      | "OPEN";
                      name?: string;
                      usageType?: | string & {}
                      | "USERBASE_GROUP"
                      | "TEAM_COLLABORATION"
                      | "ADMIN_OVERSIGHT";
                      [key: string]: unknown;
                  }[];
                  header?: string;
                  total?: number;
                  [key: string]: unknown;
              };
              users?: {
                  header?: string;
                  total?: number;
                  users?: {
                      accountId?: string;
                      accountType?: "unknown"
                      | string & {}
                      | "atlassian"
                      | "app"
                      | "customer";
                      avatarUrl?: string;
                      displayName?: string;
                      html?: string;
                      [key: string]: unknown;
                  }[];
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility