@esm-js/jira.js/src/version2/parameters/findUsers.ts

A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.

export interface FindUsers {
  /**
   * A query string that is matched against user attributes ( `displayName`, and `emailAddress`) to find relevant users.
   * The string can match the prefix of the attribute's value. For example, _query=john_ matches a user with a
   * `displayName` of _John Smith_ and a user with an `emailAddress` of _johnson@example.com_. Required, unless
   * `accountId` or `property` is specified.
   */
  query?: string;
  username?: string;
  /**
   * A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is
   * specified.
   */
  accountId?: string;
  /** The index of the first item to return in a page of filtered results (page offset). */
  startAt?: number;
  /** The maximum number of items to return per page. */
  maxResults?: number;
  /**
   * A query string used to search properties. Property keys are specified by path, so property keys containing dot (.)
   * or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To
   * search for the value of `nested` from `{"something":{"nested":1,"other":2}}` use
   * `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` is specified.
   */
  property?: string;
}