Search Users
jira.search_users
ActionBusiness appsconnection required
Calls the Jira Cloud REST API with the connection's email and API token.
Find Jira users by display name or email address.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Username & password
- Providers
- Jira
- Secret shape
- {"email", "api_token"}
- Config it needs
- domain
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
query Text matched against display name and email address. | string | Yes | — | — | — |
start_at Index of the first result to return, for paging through a long list. | number | No | 0 | ≥ 0 | — |
max_results Maximum results to return in one call. | number | No | 50 | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"max_results": 50,
"start_at": 0
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
users[].accountId The user's Atlassian accountId. | string | — |
users[].displayName The user's display name. | string | — |
users[].emailAddress The user's email, when their profile shares it. | string | — |
users[].active False for a deactivated account. | boolean | — |
users[].accountType 'atlassian', 'app' or 'customer'. | string | — |
count How many items this call returned. | number | — |
{
"count": 0,
"users": [
{
"accountId": "",
"accountType": "",
"active": false,
"displayName": "",
"emailAddress": ""
}
]
}Notes
- Email is returned only for users whose Atlassian profile visibility allows it, so matching on email can come back empty even for a real account.
See Search Users run in a workflow.
In a technical demo we add the Jira connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.