Skip to content

Commit 9079c0b

Browse files
docs: Add the documentation
1 parent 5af914d commit 9079c0b

File tree

1 file changed

+38
-3
lines changed

1 file changed

+38
-3
lines changed

docs/content/grafana_api/user.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
* [user](#user)
44
* [User](#user.User)
55
* [search\_users](#user.User.search_users)
6+
* [search\_users\_with\_paging](#user.User.search_users_with_paging)
67
* [get\_user\_by\_id](#user.User.get_user_by_id)
78
* [get\_user\_by\_username\_or\_email](#user.User.get_user_by_username_or_email)
89
* [update\_user](#user.User.update_user)
@@ -51,8 +52,41 @@ HINT: Note Grafana Enterprise API need required permissions if fine-grained acce
5152

5253
```python
5354
def search_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 is not 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
80+
81+
<a id="user.User.search_users_with_paging"></a>
82+
83+
#### search\_users\_with\_paging
84+
85+
```python
86+
def search_users_with_paging(results_per_page: int = 1000,
87+
pages: int = 1,
88+
query: str = None,
89+
sort: str = None) -> dict
5690
```
5791

5892
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:*
66100
- `results_per_page` _int_ - Specify the results_per_page as integer (default 1000)
67101
- `pages` _int_ - Specify the pages as integer (default 1)
68102
- `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 is not specified, the user list will be ordered by login, email in ascending order (default None)
69104

70105

71106
**Raises**:
@@ -75,7 +110,7 @@ Scope: global.users:*
75110

76111
**Returns**:
77112

78-
- `api_call` _list_ - Returns the list of Grafana users
113+
- `api_call` _dict_ - Returns the Grafana users
79114

80115
<a id="user.User.get_user_by_id"></a>
81116

0 commit comments

Comments
 (0)