-
Notifications
You must be signed in to change notification settings - Fork 52
Expand file tree
/
Copy pathkey_management_api.py
More file actions
888 lines (784 loc) · 32.4 KB
/
key_management_api.py
File metadata and controls
888 lines (784 loc) · 32.4 KB
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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
# This product includes software developed at Datadog (https://www.datadoghq.com/).
# Copyright 2019-Present Datadog, Inc.
from __future__ import annotations
from typing import Any, Dict, Union
from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
from datadog_api_client.configuration import Configuration
from datadog_api_client.model_utils import (
UnsetType,
unset,
)
from datadog_api_client.v2.model.api_keys_response import APIKeysResponse
from datadog_api_client.v2.model.api_keys_sort import APIKeysSort
from datadog_api_client.v2.model.api_key_response import APIKeyResponse
from datadog_api_client.v2.model.api_key_create_request import APIKeyCreateRequest
from datadog_api_client.v2.model.api_key_update_request import APIKeyUpdateRequest
from datadog_api_client.v2.model.list_application_keys_response import ListApplicationKeysResponse
from datadog_api_client.v2.model.application_keys_sort import ApplicationKeysSort
from datadog_api_client.v2.model.application_key_response import ApplicationKeyResponse
from datadog_api_client.v2.model.application_key_update_request import ApplicationKeyUpdateRequest
from datadog_api_client.v2.model.application_key_create_request import ApplicationKeyCreateRequest
class KeyManagementApi:
"""
Manage your Datadog API and application keys. You need an API key and an
application key for a user with the required permissions to interact with these endpoints.
Consult the following pages to view and manage your keys:
* `API Keys <https://app.datadoghq.com/organization-settings/api-keys>`_
* `Application Keys <https://app.datadoghq.com/personal-settings/application-keys>`_
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient(Configuration())
self.api_client = api_client
self._create_api_key_endpoint = _Endpoint(
settings={
"response_type": (APIKeyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/api_keys",
"operation_id": "create_api_key",
"http_method": "POST",
"version": "v2",
},
params_map={
"body": {
"required": True,
"openapi_types": (APIKeyCreateRequest,),
"location": "body",
},
},
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
api_client=api_client,
)
self._create_current_user_application_key_endpoint = _Endpoint(
settings={
"response_type": (ApplicationKeyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/current_user/application_keys",
"operation_id": "create_current_user_application_key",
"http_method": "POST",
"version": "v2",
},
params_map={
"body": {
"required": True,
"openapi_types": (ApplicationKeyCreateRequest,),
"location": "body",
},
},
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
api_client=api_client,
)
self._delete_api_key_endpoint = _Endpoint(
settings={
"response_type": None,
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/api_keys/{api_key_id}",
"operation_id": "delete_api_key",
"http_method": "DELETE",
"version": "v2",
},
params_map={
"api_key_id": {
"required": True,
"openapi_types": (str,),
"attribute": "api_key_id",
"location": "path",
},
},
headers_map={
"accept": ["*/*"],
},
api_client=api_client,
)
self._delete_application_key_endpoint = _Endpoint(
settings={
"response_type": None,
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/application_keys/{app_key_id}",
"operation_id": "delete_application_key",
"http_method": "DELETE",
"version": "v2",
},
params_map={
"app_key_id": {
"required": True,
"openapi_types": (str,),
"attribute": "app_key_id",
"location": "path",
},
},
headers_map={
"accept": ["*/*"],
},
api_client=api_client,
)
self._delete_current_user_application_key_endpoint = _Endpoint(
settings={
"response_type": None,
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/current_user/application_keys/{app_key_id}",
"operation_id": "delete_current_user_application_key",
"http_method": "DELETE",
"version": "v2",
},
params_map={
"app_key_id": {
"required": True,
"openapi_types": (str,),
"attribute": "app_key_id",
"location": "path",
},
},
headers_map={
"accept": ["*/*"],
},
api_client=api_client,
)
self._get_api_key_endpoint = _Endpoint(
settings={
"response_type": (APIKeyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/api_keys/{api_key_id}",
"operation_id": "get_api_key",
"http_method": "GET",
"version": "v2",
},
params_map={
"api_key_id": {
"required": True,
"openapi_types": (str,),
"attribute": "api_key_id",
"location": "path",
},
"include": {
"openapi_types": (str,),
"attribute": "include",
"location": "query",
},
},
headers_map={
"accept": ["application/json"],
},
api_client=api_client,
)
self._get_application_key_endpoint = _Endpoint(
settings={
"response_type": (ApplicationKeyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/application_keys/{app_key_id}",
"operation_id": "get_application_key",
"http_method": "GET",
"version": "v2",
},
params_map={
"app_key_id": {
"required": True,
"openapi_types": (str,),
"attribute": "app_key_id",
"location": "path",
},
"include": {
"openapi_types": (str,),
"attribute": "include",
"location": "query",
},
},
headers_map={
"accept": ["application/json"],
},
api_client=api_client,
)
self._get_current_user_application_key_endpoint = _Endpoint(
settings={
"response_type": (ApplicationKeyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/current_user/application_keys/{app_key_id}",
"operation_id": "get_current_user_application_key",
"http_method": "GET",
"version": "v2",
},
params_map={
"app_key_id": {
"required": True,
"openapi_types": (str,),
"attribute": "app_key_id",
"location": "path",
},
},
headers_map={
"accept": ["application/json"],
},
api_client=api_client,
)
self._list_api_keys_endpoint = _Endpoint(
settings={
"response_type": (APIKeysResponse,),
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/api_keys",
"operation_id": "list_api_keys",
"http_method": "GET",
"version": "v2",
},
params_map={
"page_size": {
"openapi_types": (int,),
"attribute": "page[size]",
"location": "query",
},
"page_number": {
"openapi_types": (int,),
"attribute": "page[number]",
"location": "query",
},
"sort": {
"openapi_types": (APIKeysSort,),
"attribute": "sort",
"location": "query",
},
"filter": {
"openapi_types": (str,),
"attribute": "filter",
"location": "query",
},
"filter_created_at_start": {
"openapi_types": (str,),
"attribute": "filter[created_at][start]",
"location": "query",
},
"filter_created_at_end": {
"openapi_types": (str,),
"attribute": "filter[created_at][end]",
"location": "query",
},
"filter_modified_at_start": {
"openapi_types": (str,),
"attribute": "filter[modified_at][start]",
"location": "query",
},
"filter_modified_at_end": {
"openapi_types": (str,),
"attribute": "filter[modified_at][end]",
"location": "query",
},
"include": {
"openapi_types": (str,),
"attribute": "include",
"location": "query",
},
"filter_remote_config_read_enabled": {
"openapi_types": (bool,),
"attribute": "filter[remote_config_read_enabled]",
"location": "query",
},
"filter_category": {
"openapi_types": (str,),
"attribute": "filter[category]",
"location": "query",
},
},
headers_map={
"accept": ["application/json"],
},
api_client=api_client,
)
self._list_application_keys_endpoint = _Endpoint(
settings={
"response_type": (ListApplicationKeysResponse,),
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/application_keys",
"operation_id": "list_application_keys",
"http_method": "GET",
"version": "v2",
},
params_map={
"page_size": {
"openapi_types": (int,),
"attribute": "page[size]",
"location": "query",
},
"page_number": {
"openapi_types": (int,),
"attribute": "page[number]",
"location": "query",
},
"sort": {
"openapi_types": (ApplicationKeysSort,),
"attribute": "sort",
"location": "query",
},
"filter": {
"openapi_types": (str,),
"attribute": "filter",
"location": "query",
},
"filter_created_at_start": {
"openapi_types": (str,),
"attribute": "filter[created_at][start]",
"location": "query",
},
"filter_created_at_end": {
"openapi_types": (str,),
"attribute": "filter[created_at][end]",
"location": "query",
},
"include": {
"openapi_types": (str,),
"attribute": "include",
"location": "query",
},
},
headers_map={
"accept": ["application/json"],
},
api_client=api_client,
)
self._list_current_user_application_keys_endpoint = _Endpoint(
settings={
"response_type": (ListApplicationKeysResponse,),
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/current_user/application_keys",
"operation_id": "list_current_user_application_keys",
"http_method": "GET",
"version": "v2",
},
params_map={
"page_size": {
"openapi_types": (int,),
"attribute": "page[size]",
"location": "query",
},
"page_number": {
"openapi_types": (int,),
"attribute": "page[number]",
"location": "query",
},
"sort": {
"openapi_types": (ApplicationKeysSort,),
"attribute": "sort",
"location": "query",
},
"filter": {
"openapi_types": (str,),
"attribute": "filter",
"location": "query",
},
"filter_created_at_start": {
"openapi_types": (str,),
"attribute": "filter[created_at][start]",
"location": "query",
},
"filter_created_at_end": {
"openapi_types": (str,),
"attribute": "filter[created_at][end]",
"location": "query",
},
"include": {
"openapi_types": (str,),
"attribute": "include",
"location": "query",
},
},
headers_map={
"accept": ["application/json"],
},
api_client=api_client,
)
self._update_api_key_endpoint = _Endpoint(
settings={
"response_type": (APIKeyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/api_keys/{api_key_id}",
"operation_id": "update_api_key",
"http_method": "PATCH",
"version": "v2",
},
params_map={
"api_key_id": {
"required": True,
"openapi_types": (str,),
"attribute": "api_key_id",
"location": "path",
},
"body": {
"required": True,
"openapi_types": (APIKeyUpdateRequest,),
"location": "body",
},
},
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
api_client=api_client,
)
self._update_application_key_endpoint = _Endpoint(
settings={
"response_type": (ApplicationKeyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/application_keys/{app_key_id}",
"operation_id": "update_application_key",
"http_method": "PATCH",
"version": "v2",
},
params_map={
"app_key_id": {
"required": True,
"openapi_types": (str,),
"attribute": "app_key_id",
"location": "path",
},
"body": {
"required": True,
"openapi_types": (ApplicationKeyUpdateRequest,),
"location": "body",
},
},
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
api_client=api_client,
)
self._update_current_user_application_key_endpoint = _Endpoint(
settings={
"response_type": (ApplicationKeyResponse,),
"auth": ["apiKeyAuth", "appKeyAuth"],
"endpoint_path": "/api/v2/current_user/application_keys/{app_key_id}",
"operation_id": "update_current_user_application_key",
"http_method": "PATCH",
"version": "v2",
},
params_map={
"app_key_id": {
"required": True,
"openapi_types": (str,),
"attribute": "app_key_id",
"location": "path",
},
"body": {
"required": True,
"openapi_types": (ApplicationKeyUpdateRequest,),
"location": "body",
},
},
headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
api_client=api_client,
)
def create_api_key(
self,
body: APIKeyCreateRequest,
) -> APIKeyResponse:
"""Create an API key.
Create an API key.
:type body: APIKeyCreateRequest
:rtype: APIKeyResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["body"] = body
return self._create_api_key_endpoint.call_with_http_info(**kwargs)
def create_current_user_application_key(
self,
body: ApplicationKeyCreateRequest,
) -> ApplicationKeyResponse:
"""Create an application key for current user.
Create an application key for current user
:type body: ApplicationKeyCreateRequest
:rtype: ApplicationKeyResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["body"] = body
return self._create_current_user_application_key_endpoint.call_with_http_info(**kwargs)
def delete_api_key(
self,
api_key_id: str,
) -> None:
"""Delete an API key.
Delete an API key.
:param api_key_id: The ID of the API key.
:type api_key_id: str
:rtype: None
"""
kwargs: Dict[str, Any] = {}
kwargs["api_key_id"] = api_key_id
return self._delete_api_key_endpoint.call_with_http_info(**kwargs)
def delete_application_key(
self,
app_key_id: str,
) -> None:
"""Delete an application key.
Delete an application key
:param app_key_id: The ID of the application key.
:type app_key_id: str
:rtype: None
"""
kwargs: Dict[str, Any] = {}
kwargs["app_key_id"] = app_key_id
return self._delete_application_key_endpoint.call_with_http_info(**kwargs)
def delete_current_user_application_key(
self,
app_key_id: str,
) -> None:
"""Delete an application key owned by current user.
Delete an application key owned by current user
:param app_key_id: The ID of the application key.
:type app_key_id: str
:rtype: None
"""
kwargs: Dict[str, Any] = {}
kwargs["app_key_id"] = app_key_id
return self._delete_current_user_application_key_endpoint.call_with_http_info(**kwargs)
def get_api_key(
self,
api_key_id: str,
*,
include: Union[str, UnsetType] = unset,
) -> APIKeyResponse:
"""Get API key.
Get an API key.
:param api_key_id: The ID of the API key.
:type api_key_id: str
:param include: Comma separated list of resource paths for related resources to include in the response. Supported resource paths are ``created_by`` and ``modified_by``.
:type include: str, optional
:rtype: APIKeyResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["api_key_id"] = api_key_id
if include is not unset:
kwargs["include"] = include
return self._get_api_key_endpoint.call_with_http_info(**kwargs)
def get_application_key(
self,
app_key_id: str,
*,
include: Union[str, UnsetType] = unset,
) -> ApplicationKeyResponse:
"""Get an application key.
Get an application key for your org.
:param app_key_id: The ID of the application key.
:type app_key_id: str
:param include: Resource path for related resources to include in the response. Only ``owned_by`` is supported.
:type include: str, optional
:rtype: ApplicationKeyResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["app_key_id"] = app_key_id
if include is not unset:
kwargs["include"] = include
return self._get_application_key_endpoint.call_with_http_info(**kwargs)
def get_current_user_application_key(
self,
app_key_id: str,
) -> ApplicationKeyResponse:
"""Get one application key owned by current user.
Get an application key owned by current user
:param app_key_id: The ID of the application key.
:type app_key_id: str
:rtype: ApplicationKeyResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["app_key_id"] = app_key_id
return self._get_current_user_application_key_endpoint.call_with_http_info(**kwargs)
def list_api_keys(
self,
*,
page_size: Union[int, UnsetType] = unset,
page_number: Union[int, UnsetType] = unset,
sort: Union[APIKeysSort, UnsetType] = unset,
filter: Union[str, UnsetType] = unset,
filter_created_at_start: Union[str, UnsetType] = unset,
filter_created_at_end: Union[str, UnsetType] = unset,
filter_modified_at_start: Union[str, UnsetType] = unset,
filter_modified_at_end: Union[str, UnsetType] = unset,
include: Union[str, UnsetType] = unset,
filter_remote_config_read_enabled: Union[bool, UnsetType] = unset,
filter_category: Union[str, UnsetType] = unset,
) -> APIKeysResponse:
"""Get all API keys.
List all API keys available for your account.
:param page_size: Size for a given page. The maximum allowed value is 100. Test change to trigger client generation.
:type page_size: int, optional
:param page_number: Specific page number to return.
:type page_number: int, optional
:param sort: API key attribute used to sort results. Sort order is ascending
by default. In order to specify a descending sort, prefix the
attribute with a minus sign.
:type sort: APIKeysSort, optional
:param filter: Filter API keys by the specified string.
:type filter: str, optional
:param filter_created_at_start: Only include API keys created on or after the specified date.
:type filter_created_at_start: str, optional
:param filter_created_at_end: Only include API keys created on or before the specified date.
:type filter_created_at_end: str, optional
:param filter_modified_at_start: Only include API keys modified on or after the specified date.
:type filter_modified_at_start: str, optional
:param filter_modified_at_end: Only include API keys modified on or before the specified date.
:type filter_modified_at_end: str, optional
:param include: Comma separated list of resource paths for related resources to include in the response. Supported resource paths are ``created_by`` and ``modified_by``.
:type include: str, optional
:param filter_remote_config_read_enabled: Filter API keys by remote config read enabled status.
:type filter_remote_config_read_enabled: bool, optional
:param filter_category: Filter API keys by category.
:type filter_category: str, optional
:rtype: APIKeysResponse
"""
kwargs: Dict[str, Any] = {}
if page_size is not unset:
kwargs["page_size"] = page_size
if page_number is not unset:
kwargs["page_number"] = page_number
if sort is not unset:
kwargs["sort"] = sort
if filter is not unset:
kwargs["filter"] = filter
if filter_created_at_start is not unset:
kwargs["filter_created_at_start"] = filter_created_at_start
if filter_created_at_end is not unset:
kwargs["filter_created_at_end"] = filter_created_at_end
if filter_modified_at_start is not unset:
kwargs["filter_modified_at_start"] = filter_modified_at_start
if filter_modified_at_end is not unset:
kwargs["filter_modified_at_end"] = filter_modified_at_end
if include is not unset:
kwargs["include"] = include
if filter_remote_config_read_enabled is not unset:
kwargs["filter_remote_config_read_enabled"] = filter_remote_config_read_enabled
if filter_category is not unset:
kwargs["filter_category"] = filter_category
return self._list_api_keys_endpoint.call_with_http_info(**kwargs)
def list_application_keys(
self,
*,
page_size: Union[int, UnsetType] = unset,
page_number: Union[int, UnsetType] = unset,
sort: Union[ApplicationKeysSort, UnsetType] = unset,
filter: Union[str, UnsetType] = unset,
filter_created_at_start: Union[str, UnsetType] = unset,
filter_created_at_end: Union[str, UnsetType] = unset,
include: Union[str, UnsetType] = unset,
) -> ListApplicationKeysResponse:
"""Get all application keys.
List all application keys available for your org
:param page_size: Size for a given page. The maximum allowed value is 100. Test change to trigger client generation.
:type page_size: int, optional
:param page_number: Specific page number to return.
:type page_number: int, optional
:param sort: Application key attribute used to sort results. Sort order is ascending
by default. In order to specify a descending sort, prefix the
attribute with a minus sign.
:type sort: ApplicationKeysSort, optional
:param filter: Filter application keys by the specified string.
:type filter: str, optional
:param filter_created_at_start: Only include application keys created on or after the specified date.
:type filter_created_at_start: str, optional
:param filter_created_at_end: Only include application keys created on or before the specified date.
:type filter_created_at_end: str, optional
:param include: Resource path for related resources to include in the response. Only ``owned_by`` is supported.
:type include: str, optional
:rtype: ListApplicationKeysResponse
"""
kwargs: Dict[str, Any] = {}
if page_size is not unset:
kwargs["page_size"] = page_size
if page_number is not unset:
kwargs["page_number"] = page_number
if sort is not unset:
kwargs["sort"] = sort
if filter is not unset:
kwargs["filter"] = filter
if filter_created_at_start is not unset:
kwargs["filter_created_at_start"] = filter_created_at_start
if filter_created_at_end is not unset:
kwargs["filter_created_at_end"] = filter_created_at_end
if include is not unset:
kwargs["include"] = include
return self._list_application_keys_endpoint.call_with_http_info(**kwargs)
def list_current_user_application_keys(
self,
*,
page_size: Union[int, UnsetType] = unset,
page_number: Union[int, UnsetType] = unset,
sort: Union[ApplicationKeysSort, UnsetType] = unset,
filter: Union[str, UnsetType] = unset,
filter_created_at_start: Union[str, UnsetType] = unset,
filter_created_at_end: Union[str, UnsetType] = unset,
include: Union[str, UnsetType] = unset,
) -> ListApplicationKeysResponse:
"""Get all application keys owned by current user.
List all application keys available for current user
:param page_size: Size for a given page. The maximum allowed value is 100. Test change to trigger client generation.
:type page_size: int, optional
:param page_number: Specific page number to return.
:type page_number: int, optional
:param sort: Application key attribute used to sort results. Sort order is ascending
by default. In order to specify a descending sort, prefix the
attribute with a minus sign.
:type sort: ApplicationKeysSort, optional
:param filter: Filter application keys by the specified string.
:type filter: str, optional
:param filter_created_at_start: Only include application keys created on or after the specified date.
:type filter_created_at_start: str, optional
:param filter_created_at_end: Only include application keys created on or before the specified date.
:type filter_created_at_end: str, optional
:param include: Resource path for related resources to include in the response. Only ``owned_by`` is supported.
:type include: str, optional
:rtype: ListApplicationKeysResponse
"""
kwargs: Dict[str, Any] = {}
if page_size is not unset:
kwargs["page_size"] = page_size
if page_number is not unset:
kwargs["page_number"] = page_number
if sort is not unset:
kwargs["sort"] = sort
if filter is not unset:
kwargs["filter"] = filter
if filter_created_at_start is not unset:
kwargs["filter_created_at_start"] = filter_created_at_start
if filter_created_at_end is not unset:
kwargs["filter_created_at_end"] = filter_created_at_end
if include is not unset:
kwargs["include"] = include
return self._list_current_user_application_keys_endpoint.call_with_http_info(**kwargs)
def update_api_key(
self,
api_key_id: str,
body: APIKeyUpdateRequest,
) -> APIKeyResponse:
"""Edit an API key.
Update an API key.
:param api_key_id: The ID of the API key.
:type api_key_id: str
:type body: APIKeyUpdateRequest
:rtype: APIKeyResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["api_key_id"] = api_key_id
kwargs["body"] = body
return self._update_api_key_endpoint.call_with_http_info(**kwargs)
def update_application_key(
self,
app_key_id: str,
body: ApplicationKeyUpdateRequest,
) -> ApplicationKeyResponse:
"""Edit an application key.
Edit an application key
:param app_key_id: The ID of the application key.
:type app_key_id: str
:type body: ApplicationKeyUpdateRequest
:rtype: ApplicationKeyResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["app_key_id"] = app_key_id
kwargs["body"] = body
return self._update_application_key_endpoint.call_with_http_info(**kwargs)
def update_current_user_application_key(
self,
app_key_id: str,
body: ApplicationKeyUpdateRequest,
) -> ApplicationKeyResponse:
"""Edit an application key owned by current user.
Edit an application key owned by current user
:param app_key_id: The ID of the application key.
:type app_key_id: str
:type body: ApplicationKeyUpdateRequest
:rtype: ApplicationKeyResponse
"""
kwargs: Dict[str, Any] = {}
kwargs["app_key_id"] = app_key_id
kwargs["body"] = body
return self._update_current_user_application_key_endpoint.call_with_http_info(**kwargs)