You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -51,8 +52,41 @@ HINT: Note Grafana Enterprise API need required permissions if fine-grained acce
51
52
52
53
```python
53
54
defsearch_users(results_per_page: int=1000,
54
-
pages: int=1,
55
-
query: str=None) -> list
55
+
page: int=1,
56
+
sort: str=None) -> list
57
+
```
58
+
59
+
The method includes a functionality to get all Grafana system users specified by the optional results_per_page, page and sort option
60
+
61
+
Required Permissions:
62
+
Action: users:read
63
+
Scope: global.users:*
64
+
65
+
**Arguments**:
66
+
67
+
-`results_per_page` _int_ - Specify the results_per_page as integer (default 1000)
68
+
-`page` _int_ - Specify the page as integer (default 1)
69
+
-`sort` _str_ - Specify the sort option. Valid values are login-asc, login-desc, email-asc, email-desc, name-asc, name-desc, lastSeenAtAge-asc and lastSeenAtAge-desc. By default, if sort isnot specified, the user list will be ordered by login, email in ascending order (default None)
70
+
71
+
72
+
**Raises**:
73
+
74
+
-`Exception`- Unspecified error by executing the API call
75
+
76
+
77
+
**Returns**:
78
+
79
+
-`api_call` _list_ - Returns the list of Grafana users
The method includes a functionality to get all Grafana system users specified by the optional query and paging functionality
@@ -66,6 +100,7 @@ Scope: global.users:*
66
100
-`results_per_page` _int_ - Specify the results_per_page as integer (default 1000)
67
101
-`pages` _int_ - Specify the pages as integer (default 1)
68
102
-`query` _str_ - Specify the query (default None)
103
+
-`sort` _str_ - Specify the sort option. Valid values are login-asc, login-desc, email-asc, email-desc, name-asc, name-desc, lastSeenAtAge-asc and lastSeenAtAge-desc. By default, if sort isnot specified, the user list will be ordered by login, email in ascending order (default None)
69
104
70
105
71
106
**Raises**:
@@ -75,7 +110,7 @@ Scope: global.users:*
75
110
76
111
**Returns**:
77
112
78
-
-`api_call`_list_- Returns thelist of Grafana users
0 commit comments