Find user keys by query

v1.0.0

Finds users with a structured query and returns a list of user keys.

This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use and filter the records in your code.

required: Browse users and groups .

The query statements are:

is assignee of PROJ Returns the users that are assignees of at least one issue in project PROJ.
is assignee of (PROJ-1, PROJ-2) Returns users that are assignees on the issues PROJ-1 or PROJ-2.
is reporter of (PROJ-1, PROJ-2) Returns users that are reporters on the issues PROJ-1 or PROJ-2.
is watcher of (PROJ-1, PROJ-2) Returns users that are watchers on the issues PROJ-1 or PROJ-2.
is voter of (PROJ-1, PROJ-2) Returns users that are voters on the issues PROJ-1 or PROJ-2.
is commenter of (PROJ-1, PROJ-2) Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.
is transitioner of (PROJ-1, PROJ-2) Returns users that have performed a transition on issues PROJ-1 or PROJ-2.
[propertyKey].entity.property.path is "property value" Returns users with the entity property value. For example, if user property location is set to value {"office": {"country": "AU", "city": "Sydney"}}, then it's possible to use [location].office.city is "Sydney" to match the user.

The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:

is assignee of PROJ AND [propertyKey].entity.property.path is "property value"

Input

{
  "type": "object",
  "properties": {
    "maxResult": {
      "type": "integer",
      "format": "int32"
    },
    "query": {
      "type": "string"
    },
    "startAt": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "A page of items.",
  "properties": {
    "isLast": {
      "type": "boolean",
      "description": "Whether this is the last page."
    },
    "maxResults": {
      "type": "integer",
      "format": "int32",
      "description": "The maximum number of items that could be returned."
    },
    "nextPage": {
      "type": "string",
      "format": "uri",
      "description": "If there is another page of results, the URL of the next page."
    },
    "self": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the page."
    },
    "startAt": {
      "type": "integer",
      "format": "int64",
      "description": "The index of the first item returned."
    },
    "total": {
      "type": "integer",
      "format": "int64",
      "description": "The number of items returned."
    },
    "values": {
      "type": "array",
      "description": "The list of items.",
      "items": {
        "type": "object",
        "description": "List of user account IDs.",
        "properties": {
          "accountId": {
            "type": "string",
            "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import."
          },
          "key": {
            "type": "string",
            "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}