Skip to content

Commit a11138d

Browse files
authored
Add search_user Action (#91)
* Add `search_user` Action This PR includes the `search_users` action. * Review Feedback Make Params Not required (have defaults) * Correct order of changes in CHANGES.md
1 parent d10e4d5 commit a11138d

File tree

4 files changed

+64
-1
lines changed

4 files changed

+64
-1
lines changed

CHANGES.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Change Log
22

3+
# 3.3.0
4+
- Added new ``search_users`` action. Addresses [#90](https://github.com/StackStorm-Exchange/stackstorm-jira/issues/90)
5+
36
## 3.2.3
47
- Addresses [#87](https://github.com/StackStorm-Exchange/stackstorm-jira/issues/87) JIRA sensor failure due to [deprecation of /v2/search endpoint](https://developer.atlassian.com/changelog/#CHANGE-2046)
58

actions/search_users.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
from __future__ import annotations
2+
3+
from lib.base import BaseJiraAction
4+
5+
__all__ = ["SearchJiraUsersAction"]
6+
7+
8+
class SearchJiraUsersAction(BaseJiraAction):
9+
def run(
10+
self,
11+
query,
12+
start_at: int = 0,
13+
max_results: int = 50,
14+
include_active: bool = True,
15+
include_inactive: bool = False,
16+
) -> dict[str, str]:
17+
users = self._client.search_users(
18+
query=query,
19+
startAt=start_at,
20+
maxResults=max_results,
21+
includeActive=include_active,
22+
includeInactive=include_inactive,
23+
)
24+
results = []
25+
26+
for user in users:
27+
results.append(user.raw)
28+
29+
return results

actions/search_users.yaml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: search_users
3+
runner_type: python-script
4+
description: Search JIRA users with a query
5+
enabled: true
6+
entry_point: search_users.py
7+
parameters:
8+
query:
9+
type: string
10+
description: Query string. Can be something like an email.
11+
required: true
12+
start_at:
13+
type: integer
14+
description: Offset for pagination
15+
required: false
16+
default: 0
17+
max_results:
18+
type: integer
19+
description: Maximum number of returned results
20+
default: 50
21+
required: false
22+
include_active:
23+
type: boolean
24+
description: True to include active users.
25+
required: false
26+
default: true
27+
include_inactive:
28+
type: boolean
29+
description: True to include inactive users.
30+
required: false
31+
default: false

pack.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ keywords:
66
- issues
77
- ticket management
88
- project management
9-
version: 3.2.3
9+
version: 3.3.0
1010
python_versions:
1111
- "3"
1212
author: StackStorm, Inc.

0 commit comments

Comments
 (0)