Skip to content

jira user search

  • Usage: jira user search QUERY [flags]

Search Jira users by display name or email and return their account identities. The account_id in each match is the value an ADF mention node's attrs.id requires — this command is the deterministic path from a person's name or email to a mention.

An email query resolves to a single match wherever the address is unique on the instance. Name queries may return several candidates; every match is returned so the caller can disambiguate on email_address or display_name. Inactive and deleted accounts are excluded.

Output fields

With --output json, the response envelope's data object carries these fields. Run jira agent schema for the full machine-readable schema.

Field Type Description
count integer
query string
users[].account_id string
users[].display_name string
users[].email_address string

Examples

jira user search "dev@example.com" --output=json # (1)!
jira user search "Sam" --output=json # (2)!
  1. Resolve an email to an accountId
  2. Find candidates by display name