-
Notifications
You must be signed in to change notification settings - Fork 7
/
organisation.py
575 lines (449 loc) · 19 KB
/
organisation.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
import json
import logging
from .model import APIModel, APIEndpoints, RequestsMethods
from .api import Api
class Organisation:
"""The class includes all necessary methods to access the Grafana organisation API endpoint
Args:
grafana_api_model (APIModel): Inject a Grafana API model object that includes all necessary values and information
Attributes:
grafana_api_model (APIModel): This is where we store the grafana_api_model
"""
def __init__(self, grafana_api_model: APIModel):
self.grafana_api_model = grafana_api_model
def get_current_organization(self) -> dict:
"""The method includes a functionality to get the current organization
Required Permissions:
Action: orgs:read
Scope: N/A
Raises:
Exception: Unspecified error by executing the API call
Returns:
api_call (dict): Returns the current organization
"""
api_call: dict = Api(self.grafana_api_model).call_the_api(
APIEndpoints.ORGANISATION.value
)
if api_call == dict() or api_call.get("id") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
def get_all_users_by_the_current_organization(self) -> list:
"""The method includes a functionality to get all users from the current organization
Required Permissions:
Action: org.users:read
Scope: users:*
Raises:
Exception: Unspecified error by executing the API call
Returns:
api_call (list): Returns the users of the current organization
"""
api_call: list = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATION.value}/users"
)
if api_call == list() or api_call[0].get("orgId") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
def get_all_users_by_the_current_organization_lookup(self) -> list:
"""The method includes a functionality to get the lookup information of all users from the current organization
Required Permissions:
Action: org.users:read
Scope: users:*
Raises:
Exception: Unspecified error by executing the API call
Returns:
api_call (list): Returns the users of the current organization
"""
api_call: list = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATION.value}/users/lookup"
)
if api_call == list() or api_call[0].get("userId") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
def update_organization_user_role_by_user_id(self, user_id: int, role: str):
"""The method includes a functionality to update the current organization user by the user id
Args:
user_id (int): Specify the id of the user
role (str): Specify the role of the user
Required Permissions:
Action: org.users.role:update
Scope: users:*
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
None
"""
if user_id != 0 and len(role) != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATION.value}/users/{user_id}",
RequestsMethods.PATCH,
json.dumps(dict({"role": role})),
)
if api_call.get("message") != "Organization user updated":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
logging.info("You successfully updated the organization user.")
else:
logging.error("There is no user_id or dict defined.")
raise ValueError
def delete_organization_user_by_user_id(self, user_id: int):
"""The method includes a functionality to delete the current organization user by the user id
Args:
user_id (int): Specify the id of the user
Required Permissions:
Action: org.users:remove
Scope: users:*
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
None
"""
if user_id != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATION.value}/users/{user_id}",
RequestsMethods.DELETE,
)
if api_call.get("message") != "User removed from organization":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
logging.info("You successfully removed the organization user.")
else:
logging.error("There is no user_id defined.")
raise ValueError
def update_current_organization(self, name: str):
"""The method includes a functionality to update the current organization
Args:
name (str): Specify the new name of the current organization
Required Permissions:
Action: orgs:write
Scope: N/A
Raises
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
None
"""
if len(name) != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
APIEndpoints.ORGANISATION.value,
RequestsMethods.PUT,
json.dumps(dict({"name": name})),
)
if api_call.get("message") != "Organization updated":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
logging.info("You successfully updated the organization.")
else:
logging.error("There is no role_name defined.")
raise ValueError
def add_new_user_to_current_organization(
self, login_or_email: str, role: str
) -> int:
"""The method includes a functionality to add a new user to the current organization
Args:
login_or_email (str): Specify the added user
role (str): Specify the added role for the user
Required Permissions:
Action: org.users:add
Scope: users:*
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
user_id (int): Returns the id of the created user
"""
if len(login_or_email) != 0 and len(role) != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATION.value}/users",
RequestsMethods.POST,
json.dumps(dict({"loginOrEmail": login_or_email, "role": role})),
)
if api_call.get("message") != "User added to organization":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call.get("userId")
else:
logging.error("There is no user_role defined.")
raise ValueError
class OrganisationAdmin:
"""The class includes all necessary methods to access the Grafana organisation Admin API endpoint. Be aware that all functionalities inside the class only working with basic authentication (username and password)
Args:
grafana_api_model (APIModel): Inject a Grafana API model object that includes all necessary values and information
Attributes:
grafana_api_model (APIModel): This is where we store the grafana_api_model
"""
def __init__(self, grafana_api_model: APIModel):
self.grafana_api_model = grafana_api_model
def get_organization_by_id(self, org_id: int) -> dict:
"""The method includes a functionality to get an organization by the id
Args:
org_id (int): Specify the organization id
Required Permissions:
Action: orgs:read
Scope: N/A
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
api_call (dict): Returns the organization as dict
"""
if org_id != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATIONS.value}/{org_id}"
)
if api_call == dict() or api_call.get("id") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
else:
logging.error("There is no org_id defined.")
raise ValueError
def get_organization_by_name(self, name: str) -> dict:
"""The method includes a functionality to get an organization by the name
Args:
name (str): Specify the organization name
Required Permissions:
Action: orgs:read
Scope: N/A
Note: Needs to be assigned globally.
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
api_call (dict): Returns the organization as dict
"""
if len(name) != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATIONS.value}/name/{name}"
)
if api_call == dict() or api_call.get("id") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
else:
logging.error("There is no name defined.")
raise ValueError
def get_organizations(self) -> list:
"""The method includes a functionality to get all organizations
Required Permissions:
Action: orgs:read
Scope: N/A
Note: Needs to be assigned globally.
Raises:
Exception: Unspecified error by executing the API call
Returns:
api_call (list): Returns all organizations as list
"""
api_call: list = Api(self.grafana_api_model).call_the_api(
APIEndpoints.ORGANISATIONS.value
)
if api_call == list() or api_call[0].get("id") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
def create_organization(self, name: str) -> int:
"""The method includes a functionality to create an organization
Args:
name (str): Specify the organization name
Required Permissions:
Action: orgs:create
Scope: N/A
Note: Needs to be assigned globally.
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
org_id (int): Returns the id of the created organization
"""
if len(name) != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
APIEndpoints.ORGANISATIONS.value,
RequestsMethods.POST,
json.dumps(dict({"name": name})),
)
if api_call.get("message") != "Organization created":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return int(api_call.get("orgId"))
else:
logging.error("There is no name defined.")
raise ValueError
def update_organization(self, org_id: int, name: str):
"""The method includes a functionality to update an organization
Args:
org_id (int): Specify the organization id
name (str): Specify the organization name
Required Permissions:
Action: orgs:write
Scope: N/A
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
None
"""
if org_id != 0 and len(name) != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATIONS.value}/{org_id}",
RequestsMethods.PUT,
json.dumps(dict({"name": name})),
)
if api_call.get("message") != "Organization updated":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
logging.info("You successfully updated the organization.")
else:
logging.error("There is no org_id or name defined.")
raise ValueError
def delete_organization(self, org_id: int):
"""The method includes a functionality to delete an organization
Args:
org_id (int): Specify the organization id
Required Permissions:
Action: orgs:delete
Scope: N/A
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
None
"""
if org_id != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATIONS.value}/{org_id}",
RequestsMethods.DELETE,
)
if api_call.get("message") != "Organization deleted":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
logging.info("You successfully deleted the organization.")
else:
logging.error("There is no org_id defined.")
raise ValueError
def get_organization_users(self, org_id: int) -> list:
"""The method includes a functionality to get all organization users specified by the organization id
Args:
org_id (int): Specify the organization id
Required Permissions:
Action: org.users:read
Scope: users:*
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
api_call (list): Returns all organization users as list
"""
if org_id != 0:
api_call: list = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATIONS.value}/{org_id}/users"
)
if api_call == list() or api_call[0].get("orgId") is None:
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call
else:
logging.error("There is no org_id defined.")
raise ValueError
def add_organization_user(self, org_id: int, login_or_email: str, role: str) -> int:
"""The method includes a functionality to add a user to an organization
Args:
org_id (int): Specify the organization id
login_or_email (str): Specify the added user
role (str): Specify the added role for the user
Required Permissions:
Action: org.users:add
Scope: users:*
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
user_id (int): Returns the added user id
"""
if org_id != 0 and len(login_or_email) != 0 and len(role) != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATIONS.value}/{org_id}/users",
RequestsMethods.POST,
json.dumps(dict({"loginOrEmail": login_or_email, "role": role})),
)
if api_call.get("message") != "User added to organization":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
return api_call.get("userId")
else:
logging.error("There is no org_id, login_or_email or role defined.")
raise ValueError
def update_organization_user(self, org_id: int, user_id: int, role: str):
"""The method includes a functionality to update organization user specified by the organization id, the user_id and the role
Args:
org_id (int): Specify the organization id
user_id (int): Specify the user id
role (str): Specify the added role for the user
Required Permissions:
Action: org.users.role:update
Scope: users:*
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
None
"""
if org_id != 0 and user_id != 0 and len(role) != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATIONS.value}/{org_id}/users/{user_id}",
RequestsMethods.PATCH,
json.dumps(dict({"role": role})),
)
if api_call.get("message") != "Organization user updated":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
logging.info("You successfully updated user inside the organization.")
else:
logging.error("There is no org_id, user_id or role defined.")
raise ValueError
def delete_organization_user(self, org_id: int, user_id: int):
"""The method includes a functionality to remove an organization users specified by the organization id and the user id
Args:
org_id (int): Specify the organization id
user_id (int): Specify the user id
Required Permissions:
Action: org.users:remove
Scope: users:*
Raises:
ValueError: Missed specifying a necessary value
Exception: Unspecified error by executing the API call
Returns:
None
"""
if org_id != 0 and user_id != 0:
api_call: dict = Api(self.grafana_api_model).call_the_api(
f"{APIEndpoints.ORGANISATIONS.value}/{org_id}/users/{user_id}",
RequestsMethods.DELETE,
)
if api_call.get("message") != "User removed from organization":
logging.error(f"Check the error: {api_call}.")
raise Exception
else:
logging.info("You successfully removed user from the organization.")
else:
logging.error("There is no org_id or user_id defined.")
raise ValueError