tencentcloud-sdk-python-intl-en 3.0.1075__py2.py3-none-any.whl → 3.0.1076__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of tencentcloud-sdk-python-intl-en might be problematic. Click here for more details.

Files changed (122) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/advisor/v20200721/models.py +120 -0
  3. tencentcloud/aiart/v20221229/models.py +95 -0
  4. tencentcloud/ams/v20201229/models.py +432 -0
  5. tencentcloud/antiddos/v20200309/models.py +2806 -0
  6. tencentcloud/apigateway/v20180808/models.py +3945 -0
  7. tencentcloud/autoscaling/v20180419/models.py +2449 -5
  8. tencentcloud/batch/v20170312/models.py +1566 -0
  9. tencentcloud/billing/v20180709/models.py +2418 -0
  10. tencentcloud/cam/v20190116/models.py +1697 -0
  11. tencentcloud/captcha/v20190722/models.py +70 -0
  12. tencentcloud/car/v20220110/models.py +803 -0
  13. tencentcloud/cbs/v20170312/models.py +1245 -0
  14. tencentcloud/ccc/v20200210/models.py +1949 -1
  15. tencentcloud/cdb/v20170320/models.py +4821 -0
  16. tencentcloud/cdn/v20180606/models.py +4870 -8
  17. tencentcloud/cdwdoris/v20211228/models.py +3337 -0
  18. tencentcloud/cfg/v20210820/models.py +1194 -0
  19. tencentcloud/cfs/v20190719/models.py +1178 -0
  20. tencentcloud/cfw/v20190904/models.py +2378 -0
  21. tencentcloud/chdfs/v20201112/models.py +513 -0
  22. tencentcloud/ciam/v20210420/models.py +49 -0
  23. tencentcloud/ciam/v20220331/models.py +789 -0
  24. tencentcloud/ckafka/v20190819/models.py +2576 -0
  25. tencentcloud/clb/v20180317/models.py +3220 -1
  26. tencentcloud/cloudaudit/v20190319/models.py +519 -0
  27. tencentcloud/cls/v20201016/models.py +3652 -1
  28. tencentcloud/cmq/v20190304/models.py +571 -0
  29. tencentcloud/controlcenter/v20230110/models.py +15 -0
  30. tencentcloud/csip/v20221121/models.py +2881 -2
  31. tencentcloud/cvm/v20170312/models.py +2827 -0
  32. tencentcloud/cwp/v20180228/models.py +16412 -0
  33. tencentcloud/cynosdb/v20190107/models.py +4263 -0
  34. tencentcloud/dataintegration/v20220613/models.py +18 -0
  35. tencentcloud/dayu/v20180709/models.py +3541 -12
  36. tencentcloud/dbbrain/v20191016/models.py +1056 -0
  37. tencentcloud/dbbrain/v20210527/models.py +1763 -0
  38. tencentcloud/dc/v20180410/models.py +767 -0
  39. tencentcloud/dcdb/v20180411/models.py +2335 -0
  40. tencentcloud/dlc/v20210125/models.py +3985 -5
  41. tencentcloud/dms/v20200819/models.py +51 -0
  42. tencentcloud/dnspod/v20210323/models.py +1286 -0
  43. tencentcloud/domain/v20180808/models.py +855 -0
  44. tencentcloud/dts/v20180330/models.py +791 -0
  45. tencentcloud/dts/v20211206/models.py +2317 -1
  46. tencentcloud/eb/v20210416/models.py +858 -0
  47. tencentcloud/ecdn/v20191012/models.py +811 -0
  48. tencentcloud/ecm/v20190719/models.py +3972 -1
  49. tencentcloud/eiam/v20210420/models.py +1265 -0
  50. tencentcloud/emr/v20190103/models.py +2926 -7
  51. tencentcloud/es/v20180416/models.py +1523 -0
  52. tencentcloud/facefusion/v20220927/models.py +211 -0
  53. tencentcloud/faceid/v20180301/models.py +2071 -0
  54. tencentcloud/gaap/v20180529/models.py +3103 -8
  55. tencentcloud/gme/v20180711/models.py +388 -0
  56. tencentcloud/gpm/v20200820/models.py +674 -0
  57. tencentcloud/gse/v20191112/models.py +972 -0
  58. tencentcloud/iai/v20200303/models.py +1430 -0
  59. tencentcloud/ims/v20201229/models.py +329 -0
  60. tencentcloud/intlpartnersmgt/v20220928/models.py +988 -0
  61. tencentcloud/iotcloud/v20210408/models.py +585 -0
  62. tencentcloud/ip/v20210409/models.py +178 -0
  63. tencentcloud/kms/v20190118/models.py +869 -0
  64. tencentcloud/lcic/v20220817/models.py +1658 -0
  65. tencentcloud/lighthouse/v20200324/models.py +2088 -0
  66. tencentcloud/live/v20180801/models.py +4287 -0
  67. tencentcloud/mariadb/v20170312/models.py +1905 -0
  68. tencentcloud/mdc/v20200828/models.py +1104 -0
  69. tencentcloud/mdl/v20200326/models.py +1911 -1
  70. tencentcloud/mdp/v20200527/models.py +452 -0
  71. tencentcloud/mongodb/v20190725/models.py +1234 -0
  72. tencentcloud/monitor/v20180724/models.py +5798 -2
  73. tencentcloud/mps/v20190612/models.py +8135 -0
  74. tencentcloud/msp/v20180319/models.py +183 -0
  75. tencentcloud/ocr/v20181119/models.py +3160 -1
  76. tencentcloud/omics/v20221128/models.py +1086 -0
  77. tencentcloud/organization/v20181225/models.py +285 -0
  78. tencentcloud/organization/v20210331/models.py +2267 -0
  79. tencentcloud/postgres/v20170312/models.py +3248 -0
  80. tencentcloud/privatedns/v20201028/errorcodes.py +34 -1
  81. tencentcloud/privatedns/v20201028/models.py +1700 -0
  82. tencentcloud/privatedns/v20201028/privatedns_client.py +115 -0
  83. tencentcloud/redis/v20180412/models.py +3298 -3
  84. tencentcloud/rum/v20210622/models.py +2114 -0
  85. tencentcloud/scf/v20180416/models.py +1561 -0
  86. tencentcloud/ses/v20201002/models.py +649 -0
  87. tencentcloud/sms/v20190711/models.py +575 -0
  88. tencentcloud/sms/v20210111/models.py +593 -0
  89. tencentcloud/sqlserver/v20180328/models.py +2780 -0
  90. tencentcloud/ssl/v20191205/models.py +2267 -0
  91. tencentcloud/ssm/v20190923/models.py +678 -0
  92. tencentcloud/sts/v20180813/models.py +161 -0
  93. tencentcloud/tag/v20180813/models.py +784 -0
  94. tencentcloud/tat/v20201028/models.py +806 -0
  95. tencentcloud/tcaplusdb/v20190823/models.py +1860 -0
  96. tencentcloud/tchd/v20230306/models.py +41 -0
  97. tencentcloud/tcmpp/v20240801/models.py +3761 -1
  98. tencentcloud/tcr/v20190924/models.py +1851 -0
  99. tencentcloud/tcss/v20201101/models.py +12523 -0
  100. tencentcloud/tdid/v20210519/models.py +1258 -0
  101. tencentcloud/tdmq/v20200217/models.py +3495 -0
  102. tencentcloud/tem/v20201221/models.py +803 -0
  103. tencentcloud/tem/v20210701/models.py +2551 -1
  104. tencentcloud/teo/v20220106/models.py +4731 -0
  105. tencentcloud/teo/v20220901/models.py +6066 -0
  106. tencentcloud/tiw/v20190919/models.py +1678 -1
  107. tencentcloud/tke/v20180525/models.py +3662 -0
  108. tencentcloud/tms/v20201229/models.py +176 -0
  109. tencentcloud/tmt/v20180321/models.py +65 -0
  110. tencentcloud/trtc/v20190722/models.py +1698 -8
  111. tencentcloud/tts/v20190823/models.py +72 -0
  112. tencentcloud/vm/v20201229/models.py +568 -0
  113. tencentcloud/vm/v20210922/models.py +636 -0
  114. tencentcloud/vod/v20180717/models.py +13490 -1
  115. tencentcloud/vpc/v20170312/models.py +6543 -1
  116. tencentcloud/waf/v20180125/models.py +4814 -0
  117. tencentcloud/wedata/v20210820/models.py +12594 -0
  118. tencentcloud/yunjing/v20180228/models.py +1867 -0
  119. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/METADATA +1 -1
  120. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/RECORD +122 -122
  121. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/WHEEL +0 -0
  122. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/top_level.txt +0 -0
@@ -35,6 +35,9 @@ class CreateApiImportUserJobRequest(AbstractModel):
35
35
 
36
36
  @property
37
37
  def UserStoreId(self):
38
+ """User directory ID
39
+ :rtype: str
40
+ """
38
41
  return self._UserStoreId
39
42
 
40
43
  @UserStoreId.setter
@@ -43,6 +46,9 @@ class CreateApiImportUserJobRequest(AbstractModel):
43
46
 
44
47
  @property
45
48
  def DataFlowUserCreateList(self):
49
+ """Imported user data
50
+ :rtype: list of ImportUser
51
+ """
46
52
  return self._DataFlowUserCreateList
47
53
 
48
54
  @DataFlowUserCreateList.setter
@@ -85,6 +91,9 @@ class CreateApiImportUserJobResponse(AbstractModel):
85
91
 
86
92
  @property
87
93
  def Job(self):
94
+ """Data flow task
95
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.Job`
96
+ """
88
97
  return self._Job
89
98
 
90
99
  @Job.setter
@@ -93,6 +102,9 @@ class CreateApiImportUserJobResponse(AbstractModel):
93
102
 
94
103
  @property
95
104
  def RequestId(self):
105
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
106
+ :rtype: str
107
+ """
96
108
  return self._RequestId
97
109
 
98
110
  @RequestId.setter
@@ -136,6 +148,9 @@ class CreateFileExportUserJobRequest(AbstractModel):
136
148
 
137
149
  @property
138
150
  def UserStoreId(self):
151
+ """User directory ID
152
+ :rtype: str
153
+ """
139
154
  return self._UserStoreId
140
155
 
141
156
  @UserStoreId.setter
@@ -144,6 +159,12 @@ class CreateFileExportUserJobRequest(AbstractModel):
144
159
 
145
160
  @property
146
161
  def Format(self):
162
+ """Exported data type
163
+
164
+ <li> **NDJSON** </li> New-line Delimited JSON
165
+ <li> **CSV** </li> Comma-Separated Values
166
+ :rtype: str
167
+ """
147
168
  return self._Format
148
169
 
149
170
  @Format.setter
@@ -152,6 +173,12 @@ class CreateFileExportUserJobRequest(AbstractModel):
152
173
 
153
174
  @property
154
175
  def Filters(self):
176
+ """Valid values of `Key`: `condition`, `userGroupId`.
177
+
178
+ <li> **condition** </li> Values = Query condition, which can be user ID, username, mobile number, or email address.
179
+ <li> **userGroupId** </li> Values = User group ID
180
+ :rtype: list of Filter
181
+ """
155
182
  return self._Filters
156
183
 
157
184
  @Filters.setter
@@ -160,6 +187,9 @@ class CreateFileExportUserJobRequest(AbstractModel):
160
187
 
161
188
  @property
162
189
  def ExportPropertyMaps(self):
190
+ """Attributes and mapping names included in the exported user information. If this parameter is empty, all attributes will be included.
191
+ :rtype: list of ExportPropertyMap
192
+ """
163
193
  return self._ExportPropertyMaps
164
194
 
165
195
  @ExportPropertyMaps.setter
@@ -209,6 +239,9 @@ class CreateFileExportUserJobResponse(AbstractModel):
209
239
 
210
240
  @property
211
241
  def Job(self):
242
+ """Data flow task
243
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.Job`
244
+ """
212
245
  return self._Job
213
246
 
214
247
  @Job.setter
@@ -217,6 +250,9 @@ class CreateFileExportUserJobResponse(AbstractModel):
217
250
 
218
251
  @property
219
252
  def RequestId(self):
253
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
254
+ :rtype: str
255
+ """
220
256
  return self._RequestId
221
257
 
222
258
  @RequestId.setter
@@ -287,6 +323,9 @@ class CreateUserRequest(AbstractModel):
287
323
 
288
324
  @property
289
325
  def UserStoreId(self):
326
+ """User directory ID
327
+ :rtype: str
328
+ """
290
329
  return self._UserStoreId
291
330
 
292
331
  @UserStoreId.setter
@@ -295,6 +334,9 @@ class CreateUserRequest(AbstractModel):
295
334
 
296
335
  @property
297
336
  def PhoneNumber(self):
337
+ """Mobile number
338
+ :rtype: str
339
+ """
298
340
  return self._PhoneNumber
299
341
 
300
342
  @PhoneNumber.setter
@@ -303,6 +345,9 @@ class CreateUserRequest(AbstractModel):
303
345
 
304
346
  @property
305
347
  def Email(self):
348
+ """Email address
349
+ :rtype: str
350
+ """
306
351
  return self._Email
307
352
 
308
353
  @Email.setter
@@ -311,6 +356,9 @@ class CreateUserRequest(AbstractModel):
311
356
 
312
357
  @property
313
358
  def Password(self):
359
+ """Password
360
+ :rtype: str
361
+ """
314
362
  return self._Password
315
363
 
316
364
  @Password.setter
@@ -319,6 +367,9 @@ class CreateUserRequest(AbstractModel):
319
367
 
320
368
  @property
321
369
  def UserName(self):
370
+ """Username
371
+ :rtype: str
372
+ """
322
373
  return self._UserName
323
374
 
324
375
  @UserName.setter
@@ -327,6 +378,9 @@ class CreateUserRequest(AbstractModel):
327
378
 
328
379
  @property
329
380
  def Nickname(self):
381
+ """Nickname
382
+ :rtype: str
383
+ """
330
384
  return self._Nickname
331
385
 
332
386
  @Nickname.setter
@@ -335,6 +389,9 @@ class CreateUserRequest(AbstractModel):
335
389
 
336
390
  @property
337
391
  def Address(self):
392
+ """Address
393
+ :rtype: str
394
+ """
338
395
  return self._Address
339
396
 
340
397
  @Address.setter
@@ -343,6 +400,9 @@ class CreateUserRequest(AbstractModel):
343
400
 
344
401
  @property
345
402
  def UserGroup(self):
403
+ """User group ID
404
+ :rtype: list of str
405
+ """
346
406
  return self._UserGroup
347
407
 
348
408
  @UserGroup.setter
@@ -351,6 +411,9 @@ class CreateUserRequest(AbstractModel):
351
411
 
352
412
  @property
353
413
  def Birthdate(self):
414
+ """Date of birth
415
+ :rtype: int
416
+ """
354
417
  return self._Birthdate
355
418
 
356
419
  @Birthdate.setter
@@ -359,6 +422,9 @@ class CreateUserRequest(AbstractModel):
359
422
 
360
423
  @property
361
424
  def CustomizationAttributes(self):
425
+ """Custom attribute
426
+ :rtype: list of MemberMap
427
+ """
362
428
  return self._CustomizationAttributes
363
429
 
364
430
  @CustomizationAttributes.setter
@@ -367,6 +433,9 @@ class CreateUserRequest(AbstractModel):
367
433
 
368
434
  @property
369
435
  def IndexedAttribute1(self):
436
+ """Index field 1
437
+ :rtype: str
438
+ """
370
439
  return self._IndexedAttribute1
371
440
 
372
441
  @IndexedAttribute1.setter
@@ -375,6 +444,9 @@ class CreateUserRequest(AbstractModel):
375
444
 
376
445
  @property
377
446
  def IndexedAttribute2(self):
447
+ """Index field 2
448
+ :rtype: str
449
+ """
378
450
  return self._IndexedAttribute2
379
451
 
380
452
  @IndexedAttribute2.setter
@@ -383,6 +455,9 @@ class CreateUserRequest(AbstractModel):
383
455
 
384
456
  @property
385
457
  def IndexedAttribute3(self):
458
+ """Index field 3
459
+ :rtype: str
460
+ """
386
461
  return self._IndexedAttribute3
387
462
 
388
463
  @IndexedAttribute3.setter
@@ -391,6 +466,9 @@ class CreateUserRequest(AbstractModel):
391
466
 
392
467
  @property
393
468
  def IndexedAttribute4(self):
469
+ """Index field 4
470
+ :rtype: str
471
+ """
394
472
  return self._IndexedAttribute4
395
473
 
396
474
  @IndexedAttribute4.setter
@@ -399,6 +477,9 @@ class CreateUserRequest(AbstractModel):
399
477
 
400
478
  @property
401
479
  def IndexedAttribute5(self):
480
+ """Index field 5
481
+ :rtype: str
482
+ """
402
483
  return self._IndexedAttribute5
403
484
 
404
485
  @IndexedAttribute5.setter
@@ -455,6 +536,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
455
536
 
456
537
  @property
457
538
  def User(self):
539
+ """Information of the created user
540
+ Note: This field may return null, indicating that no valid values can be obtained.
541
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.User`
542
+ """
458
543
  return self._User
459
544
 
460
545
  @User.setter
@@ -463,6 +548,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
463
548
 
464
549
  @property
465
550
  def RequestId(self):
551
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
552
+ :rtype: str
553
+ """
466
554
  return self._RequestId
467
555
 
468
556
  @RequestId.setter
@@ -494,6 +582,9 @@ class DeleteUsersRequest(AbstractModel):
494
582
 
495
583
  @property
496
584
  def UserStoreId(self):
585
+ """User directory ID
586
+ :rtype: str
587
+ """
497
588
  return self._UserStoreId
498
589
 
499
590
  @UserStoreId.setter
@@ -502,6 +593,9 @@ class DeleteUsersRequest(AbstractModel):
502
593
 
503
594
  @property
504
595
  def UserIds(self):
596
+ """Array of user IDs
597
+ :rtype: list of str
598
+ """
505
599
  return self._UserIds
506
600
 
507
601
  @UserIds.setter
@@ -536,6 +630,9 @@ class DeleteUsersResponse(AbstractModel):
536
630
 
537
631
  @property
538
632
  def RequestId(self):
633
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
634
+ :rtype: str
635
+ """
539
636
  return self._RequestId
540
637
 
541
638
  @RequestId.setter
@@ -570,6 +667,9 @@ class DescribeUserByIdRequest(AbstractModel):
570
667
 
571
668
  @property
572
669
  def UserStoreId(self):
670
+ """User directory ID
671
+ :rtype: str
672
+ """
573
673
  return self._UserStoreId
574
674
 
575
675
  @UserStoreId.setter
@@ -578,6 +678,9 @@ class DescribeUserByIdRequest(AbstractModel):
578
678
 
579
679
  @property
580
680
  def UserId(self):
681
+ """User ID
682
+ :rtype: str
683
+ """
581
684
  return self._UserId
582
685
 
583
686
  @UserId.setter
@@ -586,6 +689,12 @@ class DescribeUserByIdRequest(AbstractModel):
586
689
 
587
690
  @property
588
691
  def Original(self):
692
+ """Whether the content is passed through
693
+
694
+ <li> **false** </li>Default. The returned information is desensitized.
695
+ <li> **true** </li>Return the original content.
696
+ :rtype: bool
697
+ """
589
698
  return self._Original
590
699
 
591
700
  @Original.setter
@@ -625,6 +734,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
625
734
 
626
735
  @property
627
736
  def User(self):
737
+ """User information
738
+ Note: This field may return null, indicating that no valid values can be obtained.
739
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.User`
740
+ """
628
741
  return self._User
629
742
 
630
743
  @User.setter
@@ -633,6 +746,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
633
746
 
634
747
  @property
635
748
  def RequestId(self):
749
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
750
+ :rtype: str
751
+ """
636
752
  return self._RequestId
637
753
 
638
754
  @RequestId.setter
@@ -673,6 +789,9 @@ class DescribeUserRequest(AbstractModel):
673
789
 
674
790
  @property
675
791
  def UserStoreId(self):
792
+ """User directory ID
793
+ :rtype: str
794
+ """
676
795
  return self._UserStoreId
677
796
 
678
797
  @UserStoreId.setter
@@ -681,6 +800,9 @@ class DescribeUserRequest(AbstractModel):
681
800
 
682
801
  @property
683
802
  def Pageable(self):
803
+ """Pagination data
804
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.Pageable`
805
+ """
684
806
  return self._Pageable
685
807
 
686
808
  @Pageable.setter
@@ -689,6 +811,9 @@ class DescribeUserRequest(AbstractModel):
689
811
 
690
812
  @property
691
813
  def Filters(self):
814
+ """Query condition (`propertycode` and `propertykey`)
815
+ :rtype: list of QueryUserFilter
816
+ """
692
817
  return self._Filters
693
818
 
694
819
  @Filters.setter
@@ -697,6 +822,9 @@ class DescribeUserRequest(AbstractModel):
697
822
 
698
823
  @property
699
824
  def Original(self):
825
+ """Whether the plaintext is returned
826
+ :rtype: bool
827
+ """
700
828
  return self._Original
701
829
 
702
830
  @Original.setter
@@ -705,6 +833,9 @@ class DescribeUserRequest(AbstractModel):
705
833
 
706
834
  @property
707
835
  def Sort(self):
836
+ """Sorting configuration
837
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.Sort`
838
+ """
708
839
  return self._Sort
709
840
 
710
841
  @Sort.setter
@@ -763,6 +894,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
763
894
 
764
895
  @property
765
896
  def Total(self):
897
+ """The total number of returned results.
898
+ Note: this field may return null, indicating that no valid values can be obtained.
899
+ :rtype: int
900
+ """
766
901
  return self._Total
767
902
 
768
903
  @Total.setter
@@ -771,6 +906,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
771
906
 
772
907
  @property
773
908
  def Pageable(self):
909
+ """Pagination object
910
+ Note: this field may return null, indicating that no valid values can be obtained.
911
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.Pageable`
912
+ """
774
913
  return self._Pageable
775
914
 
776
915
  @Pageable.setter
@@ -779,6 +918,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
779
918
 
780
919
  @property
781
920
  def Content(self):
921
+ """User List
922
+ Note: this field may return null, indicating that no valid values can be obtained.
923
+ :rtype: list of User
924
+ """
782
925
  return self._Content
783
926
 
784
927
  @Content.setter
@@ -787,6 +930,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
787
930
 
788
931
  @property
789
932
  def RequestId(self):
933
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
934
+ :rtype: str
935
+ """
790
936
  return self._RequestId
791
937
 
792
938
  @RequestId.setter
@@ -826,6 +972,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
826
972
 
827
973
  @property
828
974
  def UserId(self):
975
+ """User information
976
+ Note: This field may return null, indicating that no valid values can be obtained.
977
+ :rtype: str
978
+ """
829
979
  return self._UserId
830
980
 
831
981
  @UserId.setter
@@ -834,6 +984,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
834
984
 
835
985
  @property
836
986
  def Error(self):
987
+ """Failure cause
988
+ :rtype: str
989
+ """
837
990
  return self._Error
838
991
 
839
992
  @Error.setter
@@ -871,6 +1024,9 @@ class ExportPropertyMap(AbstractModel):
871
1024
 
872
1025
  @property
873
1026
  def UserPropertyCode(self):
1027
+ """User attribute code
1028
+ :rtype: str
1029
+ """
874
1030
  return self._UserPropertyCode
875
1031
 
876
1032
  @UserPropertyCode.setter
@@ -879,6 +1035,9 @@ class ExportPropertyMap(AbstractModel):
879
1035
 
880
1036
  @property
881
1037
  def ColumnName(self):
1038
+ """User attribute mapping name
1039
+ :rtype: str
1040
+ """
882
1041
  return self._ColumnName
883
1042
 
884
1043
  @ColumnName.setter
@@ -918,6 +1077,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
918
1077
 
919
1078
  @property
920
1079
  def FailedUserIdentification(self):
1080
+ """ID of the failed user
1081
+ Note: This field may return null, indicating that no valid values can be obtained.
1082
+ :rtype: str
1083
+ """
921
1084
  return self._FailedUserIdentification
922
1085
 
923
1086
  @FailedUserIdentification.setter
@@ -926,6 +1089,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
926
1089
 
927
1090
  @property
928
1091
  def FailedReason(self):
1092
+ """Failure cause for user import
1093
+ Note: This field may return null, indicating that no valid values can be obtained.
1094
+ :rtype: str
1095
+ """
929
1096
  return self._FailedReason
930
1097
 
931
1098
  @FailedReason.setter
@@ -966,6 +1133,9 @@ class Filter(AbstractModel):
966
1133
 
967
1134
  @property
968
1135
  def Key(self):
1136
+ """Key value
1137
+ :rtype: str
1138
+ """
969
1139
  return self._Key
970
1140
 
971
1141
  @Key.setter
@@ -974,6 +1144,9 @@ class Filter(AbstractModel):
974
1144
 
975
1145
  @property
976
1146
  def Values(self):
1147
+ """Value
1148
+ :rtype: list of str
1149
+ """
977
1150
  return self._Values
978
1151
 
979
1152
  @Values.setter
@@ -982,6 +1155,9 @@ class Filter(AbstractModel):
982
1155
 
983
1156
  @property
984
1157
  def Logic(self):
1158
+ """Logical value
1159
+ :rtype: bool
1160
+ """
985
1161
  return self._Logic
986
1162
 
987
1163
  @Logic.setter
@@ -1113,6 +1289,9 @@ class ImportUser(AbstractModel):
1113
1289
 
1114
1290
  @property
1115
1291
  def UserName(self):
1292
+ """Username
1293
+ :rtype: str
1294
+ """
1116
1295
  return self._UserName
1117
1296
 
1118
1297
  @UserName.setter
@@ -1121,6 +1300,9 @@ class ImportUser(AbstractModel):
1121
1300
 
1122
1301
  @property
1123
1302
  def PhoneNumber(self):
1303
+ """Mobile number
1304
+ :rtype: str
1305
+ """
1124
1306
  return self._PhoneNumber
1125
1307
 
1126
1308
  @PhoneNumber.setter
@@ -1129,6 +1311,9 @@ class ImportUser(AbstractModel):
1129
1311
 
1130
1312
  @property
1131
1313
  def Email(self):
1314
+ """Email address
1315
+ :rtype: str
1316
+ """
1132
1317
  return self._Email
1133
1318
 
1134
1319
  @Email.setter
@@ -1137,6 +1322,9 @@ class ImportUser(AbstractModel):
1137
1322
 
1138
1323
  @property
1139
1324
  def ResidentIdentityCard(self):
1325
+ """ID card number
1326
+ :rtype: str
1327
+ """
1140
1328
  return self._ResidentIdentityCard
1141
1329
 
1142
1330
  @ResidentIdentityCard.setter
@@ -1145,6 +1333,9 @@ class ImportUser(AbstractModel):
1145
1333
 
1146
1334
  @property
1147
1335
  def Nickname(self):
1336
+ """Nickname
1337
+ :rtype: str
1338
+ """
1148
1339
  return self._Nickname
1149
1340
 
1150
1341
  @Nickname.setter
@@ -1153,6 +1344,9 @@ class ImportUser(AbstractModel):
1153
1344
 
1154
1345
  @property
1155
1346
  def Address(self):
1347
+ """Address
1348
+ :rtype: str
1349
+ """
1156
1350
  return self._Address
1157
1351
 
1158
1352
  @Address.setter
@@ -1161,6 +1355,9 @@ class ImportUser(AbstractModel):
1161
1355
 
1162
1356
  @property
1163
1357
  def UserGroup(self):
1358
+ """User group ID
1359
+ :rtype: list of str
1360
+ """
1164
1361
  return self._UserGroup
1165
1362
 
1166
1363
  @UserGroup.setter
@@ -1169,6 +1366,9 @@ class ImportUser(AbstractModel):
1169
1366
 
1170
1367
  @property
1171
1368
  def QqOpenId(self):
1369
+ """`qqOpenId` on QQ
1370
+ :rtype: str
1371
+ """
1172
1372
  return self._QqOpenId
1173
1373
 
1174
1374
  @QqOpenId.setter
@@ -1177,6 +1377,9 @@ class ImportUser(AbstractModel):
1177
1377
 
1178
1378
  @property
1179
1379
  def QqUnionId(self):
1380
+ """`qqUnionId` on QQ
1381
+ :rtype: str
1382
+ """
1180
1383
  return self._QqUnionId
1181
1384
 
1182
1385
  @QqUnionId.setter
@@ -1185,6 +1388,9 @@ class ImportUser(AbstractModel):
1185
1388
 
1186
1389
  @property
1187
1390
  def WechatOpenId(self):
1391
+ """`wechatOpenId` on WeChat
1392
+ :rtype: str
1393
+ """
1188
1394
  return self._WechatOpenId
1189
1395
 
1190
1396
  @WechatOpenId.setter
@@ -1193,6 +1399,9 @@ class ImportUser(AbstractModel):
1193
1399
 
1194
1400
  @property
1195
1401
  def WechatUnionId(self):
1402
+ """`wechatUnionId` on WeChat
1403
+ :rtype: str
1404
+ """
1196
1405
  return self._WechatUnionId
1197
1406
 
1198
1407
  @WechatUnionId.setter
@@ -1201,6 +1410,9 @@ class ImportUser(AbstractModel):
1201
1410
 
1202
1411
  @property
1203
1412
  def AlipayUserId(self):
1413
+ """`alipayUserId` on Alipay
1414
+ :rtype: str
1415
+ """
1204
1416
  return self._AlipayUserId
1205
1417
 
1206
1418
  @AlipayUserId.setter
@@ -1209,6 +1421,9 @@ class ImportUser(AbstractModel):
1209
1421
 
1210
1422
  @property
1211
1423
  def Description(self):
1424
+ """Description
1425
+ :rtype: str
1426
+ """
1212
1427
  return self._Description
1213
1428
 
1214
1429
  @Description.setter
@@ -1217,6 +1432,9 @@ class ImportUser(AbstractModel):
1217
1432
 
1218
1433
  @property
1219
1434
  def Birthdate(self):
1435
+ """Date of birth
1436
+ :rtype: str
1437
+ """
1220
1438
  return self._Birthdate
1221
1439
 
1222
1440
  @Birthdate.setter
@@ -1225,6 +1443,9 @@ class ImportUser(AbstractModel):
1225
1443
 
1226
1444
  @property
1227
1445
  def Name(self):
1446
+ """Name
1447
+ :rtype: str
1448
+ """
1228
1449
  return self._Name
1229
1450
 
1230
1451
  @Name.setter
@@ -1233,6 +1454,9 @@ class ImportUser(AbstractModel):
1233
1454
 
1234
1455
  @property
1235
1456
  def Locale(self):
1457
+ """Coordinate
1458
+ :rtype: str
1459
+ """
1236
1460
  return self._Locale
1237
1461
 
1238
1462
  @Locale.setter
@@ -1241,6 +1465,9 @@ class ImportUser(AbstractModel):
1241
1465
 
1242
1466
  @property
1243
1467
  def Gender(self):
1468
+ """Gender. Valid values: `MALE`, `FEMALE`, `UNKNOWN`.
1469
+ :rtype: str
1470
+ """
1244
1471
  return self._Gender
1245
1472
 
1246
1473
  @Gender.setter
@@ -1249,6 +1476,9 @@ class ImportUser(AbstractModel):
1249
1476
 
1250
1477
  @property
1251
1478
  def IdentityVerificationMethod(self):
1479
+ """Identity verification method
1480
+ :rtype: str
1481
+ """
1252
1482
  return self._IdentityVerificationMethod
1253
1483
 
1254
1484
  @IdentityVerificationMethod.setter
@@ -1257,6 +1487,9 @@ class ImportUser(AbstractModel):
1257
1487
 
1258
1488
  @property
1259
1489
  def IdentityVerified(self):
1490
+ """Whether the identity is verified
1491
+ :rtype: bool
1492
+ """
1260
1493
  return self._IdentityVerified
1261
1494
 
1262
1495
  @IdentityVerified.setter
@@ -1265,6 +1498,9 @@ class ImportUser(AbstractModel):
1265
1498
 
1266
1499
  @property
1267
1500
  def Job(self):
1501
+ """Job
1502
+ :rtype: str
1503
+ """
1268
1504
  return self._Job
1269
1505
 
1270
1506
  @Job.setter
@@ -1273,6 +1509,9 @@ class ImportUser(AbstractModel):
1273
1509
 
1274
1510
  @property
1275
1511
  def Nationality(self):
1512
+ """Country/Region
1513
+ :rtype: str
1514
+ """
1276
1515
  return self._Nationality
1277
1516
 
1278
1517
  @Nationality.setter
@@ -1281,6 +1520,9 @@ class ImportUser(AbstractModel):
1281
1520
 
1282
1521
  @property
1283
1522
  def Zone(self):
1523
+ """Time zone
1524
+ :rtype: str
1525
+ """
1284
1526
  return self._Zone
1285
1527
 
1286
1528
  @Zone.setter
@@ -1289,6 +1531,9 @@ class ImportUser(AbstractModel):
1289
1531
 
1290
1532
  @property
1291
1533
  def Password(self):
1534
+ """Password ciphertext
1535
+ :rtype: str
1536
+ """
1292
1537
  return self._Password
1293
1538
 
1294
1539
  @Password.setter
@@ -1297,6 +1542,9 @@ class ImportUser(AbstractModel):
1297
1542
 
1298
1543
  @property
1299
1544
  def CustomizationAttributes(self):
1545
+ """Custom attribute
1546
+ :rtype: list of MemberMap
1547
+ """
1300
1548
  return self._CustomizationAttributes
1301
1549
 
1302
1550
  @CustomizationAttributes.setter
@@ -1305,6 +1553,9 @@ class ImportUser(AbstractModel):
1305
1553
 
1306
1554
  @property
1307
1555
  def Salt(self):
1556
+ """Password salt
1557
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.Salt`
1558
+ """
1308
1559
  return self._Salt
1309
1560
 
1310
1561
  @Salt.setter
@@ -1313,6 +1564,9 @@ class ImportUser(AbstractModel):
1313
1564
 
1314
1565
  @property
1315
1566
  def PasswordEncryptTypeEnum(self):
1567
+ """Password encryption method. Valid values: `SHA1`, `BCRYPT`.
1568
+ :rtype: str
1569
+ """
1316
1570
  return self._PasswordEncryptTypeEnum
1317
1571
 
1318
1572
  @PasswordEncryptTypeEnum.setter
@@ -1321,6 +1575,9 @@ class ImportUser(AbstractModel):
1321
1575
 
1322
1576
  @property
1323
1577
  def IndexedAttribute1(self):
1578
+ """Index field 1
1579
+ :rtype: str
1580
+ """
1324
1581
  return self._IndexedAttribute1
1325
1582
 
1326
1583
  @IndexedAttribute1.setter
@@ -1329,6 +1586,9 @@ class ImportUser(AbstractModel):
1329
1586
 
1330
1587
  @property
1331
1588
  def IndexedAttribute2(self):
1589
+ """Index field 2
1590
+ :rtype: str
1591
+ """
1332
1592
  return self._IndexedAttribute2
1333
1593
 
1334
1594
  @IndexedAttribute2.setter
@@ -1337,6 +1597,9 @@ class ImportUser(AbstractModel):
1337
1597
 
1338
1598
  @property
1339
1599
  def IndexedAttribute3(self):
1600
+ """Index field 3
1601
+ :rtype: str
1602
+ """
1340
1603
  return self._IndexedAttribute3
1341
1604
 
1342
1605
  @IndexedAttribute3.setter
@@ -1345,6 +1608,9 @@ class ImportUser(AbstractModel):
1345
1608
 
1346
1609
  @property
1347
1610
  def IndexedAttribute4(self):
1611
+ """Index field 4
1612
+ :rtype: str
1613
+ """
1348
1614
  return self._IndexedAttribute4
1349
1615
 
1350
1616
  @IndexedAttribute4.setter
@@ -1353,6 +1619,9 @@ class ImportUser(AbstractModel):
1353
1619
 
1354
1620
  @property
1355
1621
  def IndexedAttribute5(self):
1622
+ """Index field 5
1623
+ :rtype: str
1624
+ """
1356
1625
  return self._IndexedAttribute5
1357
1626
 
1358
1627
  @IndexedAttribute5.setter
@@ -1459,6 +1728,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1459
1728
 
1460
1729
  @property
1461
1730
  def Id(self):
1731
+ """Task ID
1732
+ :rtype: str
1733
+ """
1462
1734
  return self._Id
1463
1735
 
1464
1736
  @Id.setter
@@ -1467,6 +1739,14 @@ Note: This field may return null, indicating that no valid values can be obtaine
1467
1739
 
1468
1740
  @property
1469
1741
  def Status(self):
1742
+ """Task status
1743
+
1744
+ <li> **PENDING** </li> Pending
1745
+ <li> **PROCESSING** </li> Executing
1746
+ <li> **COMPLETED** </li> Completed
1747
+ <li> **FAILED** </li> Failed
1748
+ :rtype: str
1749
+ """
1470
1750
  return self._Status
1471
1751
 
1472
1752
  @Status.setter
@@ -1475,6 +1755,12 @@ Note: This field may return null, indicating that no valid values can be obtaine
1475
1755
 
1476
1756
  @property
1477
1757
  def Type(self):
1758
+ """Task type
1759
+
1760
+ <li> **IMPORT_USER** </li> User import
1761
+ <li> **EXPORT_USER** </li> User export
1762
+ :rtype: str
1763
+ """
1478
1764
  return self._Type
1479
1765
 
1480
1766
  @Type.setter
@@ -1483,6 +1769,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1483
1769
 
1484
1770
  @property
1485
1771
  def CreatedDate(self):
1772
+ """Task creation time
1773
+ :rtype: int
1774
+ """
1486
1775
  return self._CreatedDate
1487
1776
 
1488
1777
  @CreatedDate.setter
@@ -1491,6 +1780,13 @@ Note: This field may return null, indicating that no valid values can be obtaine
1491
1780
 
1492
1781
  @property
1493
1782
  def Format(self):
1783
+ """Data type of the task
1784
+
1785
+ <li> **NDJSON** </li> New-line Delimited JSON
1786
+ <li> **CSV** </li> Comma-Separated Values
1787
+ Note: this field may return null, indicating that no valid values can be obtained.
1788
+ :rtype: str
1789
+ """
1494
1790
  return self._Format
1495
1791
 
1496
1792
  @Format.setter
@@ -1499,6 +1795,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1499
1795
 
1500
1796
  @property
1501
1797
  def Location(self):
1798
+ """Task result download address
1799
+ Note: This field may return null, indicating that no valid values can be obtained.
1800
+ :rtype: str
1801
+ """
1502
1802
  return self._Location
1503
1803
 
1504
1804
  @Location.setter
@@ -1507,6 +1807,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1507
1807
 
1508
1808
  @property
1509
1809
  def ErrorDetails(self):
1810
+ """Failure details
1811
+ Note: This field may return null, indicating that no valid values can be obtained.
1812
+ :rtype: list of ErrorDetails
1813
+ """
1510
1814
  return self._ErrorDetails
1511
1815
 
1512
1816
  @ErrorDetails.setter
@@ -1515,6 +1819,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1515
1819
 
1516
1820
  @property
1517
1821
  def FailedUsers(self):
1822
+ """Failed user
1823
+ Note: This field may return null, indicating that no valid values can be obtained.
1824
+ :rtype: list of FailedUsers
1825
+ """
1518
1826
  return self._FailedUsers
1519
1827
 
1520
1828
  @FailedUsers.setter
@@ -1577,6 +1885,9 @@ class LinkAccountRequest(AbstractModel):
1577
1885
 
1578
1886
  @property
1579
1887
  def UserStoreId(self):
1888
+ """User directory ID
1889
+ :rtype: str
1890
+ """
1580
1891
  return self._UserStoreId
1581
1892
 
1582
1893
  @UserStoreId.setter
@@ -1585,6 +1896,9 @@ class LinkAccountRequest(AbstractModel):
1585
1896
 
1586
1897
  @property
1587
1898
  def PrimaryUserId(self):
1899
+ """Primary user ID
1900
+ :rtype: str
1901
+ """
1588
1902
  return self._PrimaryUserId
1589
1903
 
1590
1904
  @PrimaryUserId.setter
@@ -1593,6 +1907,9 @@ class LinkAccountRequest(AbstractModel):
1593
1907
 
1594
1908
  @property
1595
1909
  def SecondaryUserId(self):
1910
+ """Secondary user ID
1911
+ :rtype: str
1912
+ """
1596
1913
  return self._SecondaryUserId
1597
1914
 
1598
1915
  @SecondaryUserId.setter
@@ -1601,6 +1918,12 @@ class LinkAccountRequest(AbstractModel):
1601
1918
 
1602
1919
  @property
1603
1920
  def UserLinkedOnAttribute(self):
1921
+ """Fusion attribute
1922
+
1923
+ <li> **PHONENUMBER** </li> Mobile number
1924
+ <li> **EMAIL** </li> Email
1925
+ :rtype: str
1926
+ """
1604
1927
  return self._UserLinkedOnAttribute
1605
1928
 
1606
1929
  @UserLinkedOnAttribute.setter
@@ -1637,6 +1960,9 @@ class LinkAccountResponse(AbstractModel):
1637
1960
 
1638
1961
  @property
1639
1962
  def RequestId(self):
1963
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
1964
+ :rtype: str
1965
+ """
1640
1966
  return self._RequestId
1641
1967
 
1642
1968
  @RequestId.setter
@@ -1665,6 +1991,9 @@ class ListJobsRequest(AbstractModel):
1665
1991
 
1666
1992
  @property
1667
1993
  def UserStoreId(self):
1994
+ """User directory ID
1995
+ :rtype: str
1996
+ """
1668
1997
  return self._UserStoreId
1669
1998
 
1670
1999
  @UserStoreId.setter
@@ -1673,6 +2002,9 @@ class ListJobsRequest(AbstractModel):
1673
2002
 
1674
2003
  @property
1675
2004
  def JobIds(self):
2005
+ """List of task IDs. If this parameter is empty, all tasks will be returned.
2006
+ :rtype: list of str
2007
+ """
1676
2008
  return self._JobIds
1677
2009
 
1678
2010
  @JobIds.setter
@@ -1711,6 +2043,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1711
2043
 
1712
2044
  @property
1713
2045
  def JobSet(self):
2046
+ """List of tasks
2047
+ Note: This field may return null, indicating that no valid values can be obtained.
2048
+ :rtype: list of Job
2049
+ """
1714
2050
  return self._JobSet
1715
2051
 
1716
2052
  @JobSet.setter
@@ -1719,6 +2055,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1719
2055
 
1720
2056
  @property
1721
2057
  def RequestId(self):
2058
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2059
+ :rtype: str
2060
+ """
1722
2061
  return self._RequestId
1723
2062
 
1724
2063
  @RequestId.setter
@@ -1761,6 +2100,9 @@ class ListLogMessageByConditionRequest(AbstractModel):
1761
2100
 
1762
2101
  @property
1763
2102
  def UserStoreId(self):
2103
+ """User pool ID
2104
+ :rtype: str
2105
+ """
1764
2106
  return self._UserStoreId
1765
2107
 
1766
2108
  @UserStoreId.setter
@@ -1769,6 +2111,9 @@ class ListLogMessageByConditionRequest(AbstractModel):
1769
2111
 
1770
2112
  @property
1771
2113
  def Pageable(self):
2114
+ """Pagination data
2115
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.Pageable`
2116
+ """
1772
2117
  return self._Pageable
1773
2118
 
1774
2119
  @Pageable.setter
@@ -1777,6 +2122,9 @@ class ListLogMessageByConditionRequest(AbstractModel):
1777
2122
 
1778
2123
  @property
1779
2124
  def StartTime(self):
2125
+ """Start timestamp accurate to the millisecond
2126
+ :rtype: int
2127
+ """
1780
2128
  return self._StartTime
1781
2129
 
1782
2130
  @StartTime.setter
@@ -1785,6 +2133,11 @@ class ListLogMessageByConditionRequest(AbstractModel):
1785
2133
 
1786
2134
  @property
1787
2135
  def Filters(self):
2136
+ """Valid values of `Key`: `events`.
2137
+
2138
+ <li> **events** </li> Values can be one or multiple items in ["SIGNUP", "USER_UPDATE", "USER_DELETE", "USER_CREATE", "ACCOUNT_LINKING"].
2139
+ :rtype: list of Filter
2140
+ """
1788
2141
  return self._Filters
1789
2142
 
1790
2143
  @Filters.setter
@@ -1838,6 +2191,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1838
2191
 
1839
2192
  @property
1840
2193
  def Total(self):
2194
+ """Total number
2195
+ :rtype: int
2196
+ """
1841
2197
  return self._Total
1842
2198
 
1843
2199
  @Total.setter
@@ -1846,6 +2202,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1846
2202
 
1847
2203
  @property
1848
2204
  def Pageable(self):
2205
+ """Pagination object
2206
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.Pageable`
2207
+ """
1849
2208
  return self._Pageable
1850
2209
 
1851
2210
  @Pageable.setter
@@ -1854,6 +2213,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1854
2213
 
1855
2214
  @property
1856
2215
  def Content(self):
2216
+ """List of logs
2217
+ Note: This field may return null, indicating that no valid values can be obtained.
2218
+ :rtype: list of LogMessage
2219
+ """
1857
2220
  return self._Content
1858
2221
 
1859
2222
  @Content.setter
@@ -1862,6 +2225,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1862
2225
 
1863
2226
  @property
1864
2227
  def RequestId(self):
2228
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2229
+ :rtype: str
2230
+ """
1865
2231
  return self._RequestId
1866
2232
 
1867
2233
  @RequestId.setter
@@ -1909,6 +2275,9 @@ class ListUserByPropertyRequest(AbstractModel):
1909
2275
 
1910
2276
  @property
1911
2277
  def UserStoreId(self):
2278
+ """User directory ID
2279
+ :rtype: str
2280
+ """
1912
2281
  return self._UserStoreId
1913
2282
 
1914
2283
  @UserStoreId.setter
@@ -1917,6 +2286,12 @@ class ListUserByPropertyRequest(AbstractModel):
1917
2286
 
1918
2287
  @property
1919
2288
  def PropertyCode(self):
2289
+ """Query attribute
2290
+
2291
+ <li> **phoneNumber** </li> Mobile number
2292
+ <li> **email** </li> Email
2293
+ :rtype: str
2294
+ """
1920
2295
  return self._PropertyCode
1921
2296
 
1922
2297
  @PropertyCode.setter
@@ -1925,6 +2300,9 @@ class ListUserByPropertyRequest(AbstractModel):
1925
2300
 
1926
2301
  @property
1927
2302
  def PropertyValue(self):
2303
+ """Attribute value
2304
+ :rtype: str
2305
+ """
1928
2306
  return self._PropertyValue
1929
2307
 
1930
2308
  @PropertyValue.setter
@@ -1933,6 +2311,9 @@ class ListUserByPropertyRequest(AbstractModel):
1933
2311
 
1934
2312
  @property
1935
2313
  def Original(self):
2314
+ """Whether the content is passed through
2315
+ :rtype: bool
2316
+ """
1936
2317
  return self._Original
1937
2318
 
1938
2319
  @Original.setter
@@ -1973,6 +2354,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
1973
2354
 
1974
2355
  @property
1975
2356
  def Users(self):
2357
+ """List of users
2358
+ Note: This field may return null, indicating that no valid values can be obtained.
2359
+ :rtype: list of User
2360
+ """
1976
2361
  return self._Users
1977
2362
 
1978
2363
  @Users.setter
@@ -1981,6 +2366,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
1981
2366
 
1982
2367
  @property
1983
2368
  def RequestId(self):
2369
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2370
+ :rtype: str
2371
+ """
1984
2372
  return self._RequestId
1985
2373
 
1986
2374
  @RequestId.setter
@@ -2024,6 +2412,9 @@ class ListUserRequest(AbstractModel):
2024
2412
 
2025
2413
  @property
2026
2414
  def UserStoreId(self):
2415
+ """User directory ID
2416
+ :rtype: str
2417
+ """
2027
2418
  return self._UserStoreId
2028
2419
 
2029
2420
  @UserStoreId.setter
@@ -2032,6 +2423,9 @@ class ListUserRequest(AbstractModel):
2032
2423
 
2033
2424
  @property
2034
2425
  def Pageable(self):
2426
+ """Pagination data
2427
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.Pageable`
2428
+ """
2035
2429
  return self._Pageable
2036
2430
 
2037
2431
  @Pageable.setter
@@ -2040,6 +2434,12 @@ class ListUserRequest(AbstractModel):
2040
2434
 
2041
2435
  @property
2042
2436
  def Filters(self):
2437
+ """Valid values of `Key`: `condition`, `userGroupId`.
2438
+
2439
+ <li> **condition** </li> Values = Query condition, which can be user ID, username, mobile number, or email address.
2440
+ <li> **userGroupId** </li> Values = User group ID
2441
+ :rtype: list of Filter
2442
+ """
2043
2443
  return self._Filters
2044
2444
 
2045
2445
  @Filters.setter
@@ -2048,6 +2448,9 @@ class ListUserRequest(AbstractModel):
2048
2448
 
2049
2449
  @property
2050
2450
  def Original(self):
2451
+ """Whether the content is passed through
2452
+ :rtype: bool
2453
+ """
2051
2454
  return self._Original
2052
2455
 
2053
2456
  @Original.setter
@@ -2103,6 +2506,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2103
2506
 
2104
2507
  @property
2105
2508
  def Total(self):
2509
+ """Total number
2510
+ Note: This field may return null, indicating that no valid values can be obtained.
2511
+ :rtype: int
2512
+ """
2106
2513
  return self._Total
2107
2514
 
2108
2515
  @Total.setter
@@ -2111,6 +2518,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2111
2518
 
2112
2519
  @property
2113
2520
  def Pageable(self):
2521
+ """Pagination object
2522
+ Note: This field may return null, indicating that no valid values can be obtained.
2523
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.Pageable`
2524
+ """
2114
2525
  return self._Pageable
2115
2526
 
2116
2527
  @Pageable.setter
@@ -2119,6 +2530,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2119
2530
 
2120
2531
  @property
2121
2532
  def Content(self):
2533
+ """List of users
2534
+ Note: This field may return null, indicating that no valid values can be obtained.
2535
+ :rtype: list of User
2536
+ """
2122
2537
  return self._Content
2123
2538
 
2124
2539
  @Content.setter
@@ -2127,6 +2542,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2127
2542
 
2128
2543
  @property
2129
2544
  def RequestId(self):
2545
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2546
+ :rtype: str
2547
+ """
2130
2548
  return self._RequestId
2131
2549
 
2132
2550
  @RequestId.setter
@@ -2229,6 +2647,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2229
2647
 
2230
2648
  @property
2231
2649
  def LogId(self):
2650
+ """Log ID
2651
+ :rtype: str
2652
+ """
2232
2653
  return self._LogId
2233
2654
 
2234
2655
  @LogId.setter
@@ -2237,6 +2658,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2237
2658
 
2238
2659
  @property
2239
2660
  def TenantId(self):
2661
+ """Tenant ID
2662
+ Note: This field may return null, indicating that no valid values can be obtained.
2663
+ :rtype: str
2664
+ """
2240
2665
  return self._TenantId
2241
2666
 
2242
2667
  @TenantId.setter
@@ -2245,6 +2670,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2245
2670
 
2246
2671
  @property
2247
2672
  def UserStoreId(self):
2673
+ """User pool ID
2674
+ Note: This field may return null, indicating that no valid values can be obtained.
2675
+ :rtype: str
2676
+ """
2248
2677
  return self._UserStoreId
2249
2678
 
2250
2679
  @UserStoreId.setter
@@ -2253,6 +2682,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2253
2682
 
2254
2683
  @property
2255
2684
  def EventCode(self):
2685
+ """Event code
2686
+ Note: This field may return null, indicating that no valid values can be obtained.
2687
+ :rtype: str
2688
+ """
2256
2689
  return self._EventCode
2257
2690
 
2258
2691
  @EventCode.setter
@@ -2261,6 +2694,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2261
2694
 
2262
2695
  @property
2263
2696
  def EventDate(self):
2697
+ """Event timestamp in milliseconds
2698
+ Note: This field may return null, indicating that no valid values can be obtained.
2699
+ :rtype: int
2700
+ """
2264
2701
  return self._EventDate
2265
2702
 
2266
2703
  @EventDate.setter
@@ -2269,6 +2706,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2269
2706
 
2270
2707
  @property
2271
2708
  def Description(self):
2709
+ """Description
2710
+ Note: This field may return null, indicating that no valid values can be obtained.
2711
+ :rtype: str
2712
+ """
2272
2713
  return self._Description
2273
2714
 
2274
2715
  @Description.setter
@@ -2277,6 +2718,13 @@ Note: This field may return null, indicating that no valid values can be obtaine
2277
2718
 
2278
2719
  @property
2279
2720
  def Participant(self):
2721
+ """Event participant
2722
+
2723
+ <li> **TENANT** </li> Tenant
2724
+ <li> **USER** </li> User
2725
+ Note: This field may return null, indicating that no valid values can be obtained.
2726
+ :rtype: str
2727
+ """
2280
2728
  return self._Participant
2281
2729
 
2282
2730
  @Participant.setter
@@ -2285,6 +2733,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2285
2733
 
2286
2734
  @property
2287
2735
  def ApplicationClientId(self):
2736
+ """Application `clientId`
2737
+ Note: This field may return null, indicating that no valid values can be obtained.
2738
+ :rtype: str
2739
+ """
2288
2740
  return self._ApplicationClientId
2289
2741
 
2290
2742
  @ApplicationClientId.setter
@@ -2293,6 +2745,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2293
2745
 
2294
2746
  @property
2295
2747
  def ApplicationName(self):
2748
+ """Application name
2749
+ Note: This field may return null, indicating that no valid values can be obtained.
2750
+ :rtype: str
2751
+ """
2296
2752
  return self._ApplicationName
2297
2753
 
2298
2754
  @ApplicationName.setter
@@ -2301,6 +2757,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2301
2757
 
2302
2758
  @property
2303
2759
  def AuthSourceId(self):
2760
+ """Authentication source ID
2761
+ Note: This field may return null, indicating that no valid values can be obtained.
2762
+ :rtype: str
2763
+ """
2304
2764
  return self._AuthSourceId
2305
2765
 
2306
2766
  @AuthSourceId.setter
@@ -2309,6 +2769,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2309
2769
 
2310
2770
  @property
2311
2771
  def AuthSourceName(self):
2772
+ """Authentication source name
2773
+ Note: This field may return null, indicating that no valid values can be obtained.
2774
+ :rtype: str
2775
+ """
2312
2776
  return self._AuthSourceName
2313
2777
 
2314
2778
  @AuthSourceName.setter
@@ -2317,6 +2781,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2317
2781
 
2318
2782
  @property
2319
2783
  def AuthSourceType(self):
2784
+ """Authentication source type
2785
+ Note: This field may return null, indicating that no valid values can be obtained.
2786
+ :rtype: str
2787
+ """
2320
2788
  return self._AuthSourceType
2321
2789
 
2322
2790
  @AuthSourceType.setter
@@ -2325,6 +2793,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2325
2793
 
2326
2794
  @property
2327
2795
  def AuthSourceCategory(self):
2796
+ """Authentication source category
2797
+ Note: This field may return null, indicating that no valid values can be obtained.
2798
+ :rtype: str
2799
+ """
2328
2800
  return self._AuthSourceCategory
2329
2801
 
2330
2802
  @AuthSourceCategory.setter
@@ -2333,6 +2805,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2333
2805
 
2334
2806
  @property
2335
2807
  def Ip(self):
2808
+ """IP address
2809
+ Note: This field may return null, indicating that no valid values can be obtained.
2810
+ :rtype: str
2811
+ """
2336
2812
  return self._Ip
2337
2813
 
2338
2814
  @Ip.setter
@@ -2341,6 +2817,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2341
2817
 
2342
2818
  @property
2343
2819
  def UserAgent(self):
2820
+ """User agent
2821
+ Note: This field may return null, indicating that no valid values can be obtained.
2822
+ :rtype: str
2823
+ """
2344
2824
  return self._UserAgent
2345
2825
 
2346
2826
  @UserAgent.setter
@@ -2349,6 +2829,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2349
2829
 
2350
2830
  @property
2351
2831
  def UserId(self):
2832
+ """User ID
2833
+ Note: This field may return null, indicating that no valid values can be obtained.
2834
+ :rtype: str
2835
+ """
2352
2836
  return self._UserId
2353
2837
 
2354
2838
  @UserId.setter
@@ -2357,6 +2841,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2357
2841
 
2358
2842
  @property
2359
2843
  def Detail(self):
2844
+ """Details
2845
+ Note: This field may return null, indicating that no valid values can be obtained.
2846
+ :rtype: str
2847
+ """
2360
2848
  return self._Detail
2361
2849
 
2362
2850
  @Detail.setter
@@ -2413,6 +2901,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2413
2901
 
2414
2902
  @property
2415
2903
  def Name(self):
2904
+ """Key
2905
+ :rtype: str
2906
+ """
2416
2907
  return self._Name
2417
2908
 
2418
2909
  @Name.setter
@@ -2421,6 +2912,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2421
2912
 
2422
2913
  @property
2423
2914
  def Value(self):
2915
+ """Value
2916
+ :rtype: str
2917
+ """
2424
2918
  return self._Value
2425
2919
 
2426
2920
  @Value.setter
@@ -2429,6 +2923,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2429
2923
 
2430
2924
  @property
2431
2925
  def Type(self):
2926
+ """Type
2927
+ Note: This field may return null, indicating that no valid values can be obtained.
2928
+ :rtype: str
2929
+ """
2432
2930
  return self._Type
2433
2931
 
2434
2932
  @Type.setter
@@ -2467,6 +2965,9 @@ class Pageable(AbstractModel):
2467
2965
 
2468
2966
  @property
2469
2967
  def PageSize(self):
2968
+ """Number of entries per page
2969
+ :rtype: int
2970
+ """
2470
2971
  return self._PageSize
2471
2972
 
2472
2973
  @PageSize.setter
@@ -2475,6 +2976,9 @@ class Pageable(AbstractModel):
2475
2976
 
2476
2977
  @property
2477
2978
  def PageNumber(self):
2979
+ """Current page number
2980
+ :rtype: int
2981
+ """
2478
2982
  return self._PageNumber
2479
2983
 
2480
2984
  @PageNumber.setter
@@ -2518,6 +3022,9 @@ class QueryUserFilter(AbstractModel):
2518
3022
 
2519
3023
  @property
2520
3024
  def PropertyKey(self):
3025
+ """Property key
3026
+ :rtype: str
3027
+ """
2521
3028
  return self._PropertyKey
2522
3029
 
2523
3030
  @PropertyKey.setter
@@ -2526,6 +3033,9 @@ class QueryUserFilter(AbstractModel):
2526
3033
 
2527
3034
  @property
2528
3035
  def PropertyValue(self):
3036
+ """Property value
3037
+ :rtype: str
3038
+ """
2529
3039
  return self._PropertyValue
2530
3040
 
2531
3041
  @PropertyValue.setter
@@ -2534,6 +3044,9 @@ class QueryUserFilter(AbstractModel):
2534
3044
 
2535
3045
  @property
2536
3046
  def Logic(self):
3047
+ """Logic value. `True` or `False`
3048
+ :rtype: bool
3049
+ """
2537
3050
  return self._Logic
2538
3051
 
2539
3052
  @Logic.setter
@@ -2542,6 +3055,9 @@ class QueryUserFilter(AbstractModel):
2542
3055
 
2543
3056
  @property
2544
3057
  def OperateLogic(self):
3058
+ """Operator. Values: `>`, `<`, `=`, `>=`, `<=`, `!=` and `between`.
3059
+ :rtype: str
3060
+ """
2545
3061
  return self._OperateLogic
2546
3062
 
2547
3063
  @OperateLogic.setter
@@ -2581,6 +3097,9 @@ class ResetPasswordRequest(AbstractModel):
2581
3097
 
2582
3098
  @property
2583
3099
  def UserId(self):
3100
+ """User ID
3101
+ :rtype: str
3102
+ """
2584
3103
  return self._UserId
2585
3104
 
2586
3105
  @UserId.setter
@@ -2589,6 +3108,9 @@ class ResetPasswordRequest(AbstractModel):
2589
3108
 
2590
3109
  @property
2591
3110
  def UserStoreId(self):
3111
+ """User directory ID
3112
+ :rtype: str
3113
+ """
2592
3114
  return self._UserStoreId
2593
3115
 
2594
3116
  @UserStoreId.setter
@@ -2626,6 +3148,9 @@ class ResetPasswordResponse(AbstractModel):
2626
3148
 
2627
3149
  @property
2628
3150
  def Password(self):
3151
+ """User password after reset
3152
+ :rtype: str
3153
+ """
2629
3154
  return self._Password
2630
3155
 
2631
3156
  @Password.setter
@@ -2634,6 +3159,9 @@ class ResetPasswordResponse(AbstractModel):
2634
3159
 
2635
3160
  @property
2636
3161
  def RequestId(self):
3162
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3163
+ :rtype: str
3164
+ """
2637
3165
  return self._RequestId
2638
3166
 
2639
3167
  @RequestId.setter
@@ -2663,6 +3191,9 @@ class Salt(AbstractModel):
2663
3191
 
2664
3192
  @property
2665
3193
  def SaltValue(self):
3194
+ """Salt value
3195
+ :rtype: str
3196
+ """
2666
3197
  return self._SaltValue
2667
3198
 
2668
3199
  @SaltValue.setter
@@ -2671,6 +3202,9 @@ class Salt(AbstractModel):
2671
3202
 
2672
3203
  @property
2673
3204
  def SaltLocation(self):
3205
+ """Salt value location
3206
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.SaltLocation`
3207
+ """
2674
3208
  return self._SaltLocation
2675
3209
 
2676
3210
  @SaltLocation.setter
@@ -2710,6 +3244,9 @@ class SaltLocation(AbstractModel):
2710
3244
 
2711
3245
  @property
2712
3246
  def SaltLocationTypeEnum(self):
3247
+ """Password salt type. Valid values: `HEAD`, `TAIL`, `OTHER`.
3248
+ :rtype: str
3249
+ """
2713
3250
  return self._SaltLocationTypeEnum
2714
3251
 
2715
3252
  @SaltLocationTypeEnum.setter
@@ -2718,6 +3255,9 @@ class SaltLocation(AbstractModel):
2718
3255
 
2719
3256
  @property
2720
3257
  def SaltLocationRule(self):
3258
+ """Salting rule
3259
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.SaltLocationRule`
3260
+ """
2721
3261
  return self._SaltLocationRule
2722
3262
 
2723
3263
  @SaltLocationRule.setter
@@ -2754,6 +3294,9 @@ class SaltLocationRule(AbstractModel):
2754
3294
 
2755
3295
  @property
2756
3296
  def Regex(self):
3297
+ """Expression
3298
+ :rtype: str
3299
+ """
2757
3300
  return self._Regex
2758
3301
 
2759
3302
  @Regex.setter
@@ -2793,6 +3336,9 @@ class SetPasswordRequest(AbstractModel):
2793
3336
 
2794
3337
  @property
2795
3338
  def UserStoreId(self):
3339
+ """User directory ID
3340
+ :rtype: str
3341
+ """
2796
3342
  return self._UserStoreId
2797
3343
 
2798
3344
  @UserStoreId.setter
@@ -2801,6 +3347,9 @@ class SetPasswordRequest(AbstractModel):
2801
3347
 
2802
3348
  @property
2803
3349
  def UserId(self):
3350
+ """User ID
3351
+ :rtype: str
3352
+ """
2804
3353
  return self._UserId
2805
3354
 
2806
3355
  @UserId.setter
@@ -2809,6 +3358,9 @@ class SetPasswordRequest(AbstractModel):
2809
3358
 
2810
3359
  @property
2811
3360
  def Password(self):
3361
+ """Password
3362
+ :rtype: str
3363
+ """
2812
3364
  return self._Password
2813
3365
 
2814
3366
  @Password.setter
@@ -2844,6 +3396,9 @@ class SetPasswordResponse(AbstractModel):
2844
3396
 
2845
3397
  @property
2846
3398
  def RequestId(self):
3399
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3400
+ :rtype: str
3401
+ """
2847
3402
  return self._RequestId
2848
3403
 
2849
3404
  @RequestId.setter
@@ -2872,6 +3427,9 @@ class Sort(AbstractModel):
2872
3427
 
2873
3428
  @property
2874
3429
  def PropertyKey(self):
3430
+ """Key for sorting. See custom attributes
3431
+ :rtype: str
3432
+ """
2875
3433
  return self._PropertyKey
2876
3434
 
2877
3435
  @PropertyKey.setter
@@ -2880,6 +3438,9 @@ class Sort(AbstractModel):
2880
3438
 
2881
3439
  @property
2882
3440
  def Order(self):
3441
+ """`ASC` or `DESC`
3442
+ :rtype: str
3443
+ """
2883
3444
  return self._Order
2884
3445
 
2885
3446
  @Order.setter
@@ -2956,6 +3517,9 @@ class UpdateUserRequest(AbstractModel):
2956
3517
 
2957
3518
  @property
2958
3519
  def UserId(self):
3520
+ """User ID
3521
+ :rtype: str
3522
+ """
2959
3523
  return self._UserId
2960
3524
 
2961
3525
  @UserId.setter
@@ -2964,6 +3528,9 @@ class UpdateUserRequest(AbstractModel):
2964
3528
 
2965
3529
  @property
2966
3530
  def UserStoreId(self):
3531
+ """User directory ID
3532
+ :rtype: str
3533
+ """
2967
3534
  return self._UserStoreId
2968
3535
 
2969
3536
  @UserStoreId.setter
@@ -2972,6 +3539,9 @@ class UpdateUserRequest(AbstractModel):
2972
3539
 
2973
3540
  @property
2974
3541
  def UserName(self):
3542
+ """Username
3543
+ :rtype: str
3544
+ """
2975
3545
  return self._UserName
2976
3546
 
2977
3547
  @UserName.setter
@@ -2980,6 +3550,9 @@ class UpdateUserRequest(AbstractModel):
2980
3550
 
2981
3551
  @property
2982
3552
  def PhoneNumber(self):
3553
+ """Mobile number
3554
+ :rtype: str
3555
+ """
2983
3556
  return self._PhoneNumber
2984
3557
 
2985
3558
  @PhoneNumber.setter
@@ -2988,6 +3561,9 @@ class UpdateUserRequest(AbstractModel):
2988
3561
 
2989
3562
  @property
2990
3563
  def Email(self):
3564
+ """Email address
3565
+ :rtype: str
3566
+ """
2991
3567
  return self._Email
2992
3568
 
2993
3569
  @Email.setter
@@ -2996,6 +3572,9 @@ class UpdateUserRequest(AbstractModel):
2996
3572
 
2997
3573
  @property
2998
3574
  def Nickname(self):
3575
+ """Nickname
3576
+ :rtype: str
3577
+ """
2999
3578
  return self._Nickname
3000
3579
 
3001
3580
  @Nickname.setter
@@ -3004,6 +3583,9 @@ class UpdateUserRequest(AbstractModel):
3004
3583
 
3005
3584
  @property
3006
3585
  def Address(self):
3586
+ """Address
3587
+ :rtype: str
3588
+ """
3007
3589
  return self._Address
3008
3590
 
3009
3591
  @Address.setter
@@ -3012,6 +3594,9 @@ class UpdateUserRequest(AbstractModel):
3012
3594
 
3013
3595
  @property
3014
3596
  def UserGroup(self):
3597
+ """User group
3598
+ :rtype: list of str
3599
+ """
3015
3600
  return self._UserGroup
3016
3601
 
3017
3602
  @UserGroup.setter
@@ -3020,6 +3605,9 @@ class UpdateUserRequest(AbstractModel):
3020
3605
 
3021
3606
  @property
3022
3607
  def Birthdate(self):
3608
+ """Date of birth
3609
+ :rtype: int
3610
+ """
3023
3611
  return self._Birthdate
3024
3612
 
3025
3613
  @Birthdate.setter
@@ -3028,6 +3616,9 @@ class UpdateUserRequest(AbstractModel):
3028
3616
 
3029
3617
  @property
3030
3618
  def CustomizationAttributes(self):
3619
+ """Custom attribute
3620
+ :rtype: list of MemberMap
3621
+ """
3031
3622
  return self._CustomizationAttributes
3032
3623
 
3033
3624
  @CustomizationAttributes.setter
@@ -3036,6 +3627,9 @@ class UpdateUserRequest(AbstractModel):
3036
3627
 
3037
3628
  @property
3038
3629
  def IndexedAttribute1(self):
3630
+ """Index field 1
3631
+ :rtype: str
3632
+ """
3039
3633
  return self._IndexedAttribute1
3040
3634
 
3041
3635
  @IndexedAttribute1.setter
@@ -3044,6 +3638,9 @@ class UpdateUserRequest(AbstractModel):
3044
3638
 
3045
3639
  @property
3046
3640
  def IndexedAttribute2(self):
3641
+ """Index field 2
3642
+ :rtype: str
3643
+ """
3047
3644
  return self._IndexedAttribute2
3048
3645
 
3049
3646
  @IndexedAttribute2.setter
@@ -3052,6 +3649,9 @@ class UpdateUserRequest(AbstractModel):
3052
3649
 
3053
3650
  @property
3054
3651
  def IndexedAttribute3(self):
3652
+ """Index field 3
3653
+ :rtype: str
3654
+ """
3055
3655
  return self._IndexedAttribute3
3056
3656
 
3057
3657
  @IndexedAttribute3.setter
@@ -3060,6 +3660,9 @@ class UpdateUserRequest(AbstractModel):
3060
3660
 
3061
3661
  @property
3062
3662
  def IndexedAttribute4(self):
3663
+ """Index field 4
3664
+ :rtype: str
3665
+ """
3063
3666
  return self._IndexedAttribute4
3064
3667
 
3065
3668
  @IndexedAttribute4.setter
@@ -3068,6 +3671,9 @@ class UpdateUserRequest(AbstractModel):
3068
3671
 
3069
3672
  @property
3070
3673
  def IndexedAttribute5(self):
3674
+ """Index field 5
3675
+ :rtype: str
3676
+ """
3071
3677
  return self._IndexedAttribute5
3072
3678
 
3073
3679
  @IndexedAttribute5.setter
@@ -3124,6 +3730,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
3124
3730
 
3125
3731
  @property
3126
3732
  def User(self):
3733
+ """User information after update
3734
+ Note: This field may return null, indicating that no valid values can be obtained.
3735
+ :rtype: :class:`tencentcloud.ciam.v20220331.models.User`
3736
+ """
3127
3737
  return self._User
3128
3738
 
3129
3739
  @User.setter
@@ -3132,6 +3742,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
3132
3742
 
3133
3743
  @property
3134
3744
  def RequestId(self):
3745
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3746
+ :rtype: str
3747
+ """
3135
3748
  return self._RequestId
3136
3749
 
3137
3750
  @RequestId.setter
@@ -3170,6 +3783,9 @@ class UpdateUserStatusRequest(AbstractModel):
3170
3783
 
3171
3784
  @property
3172
3785
  def UserStoreId(self):
3786
+ """User directory ID
3787
+ :rtype: str
3788
+ """
3173
3789
  return self._UserStoreId
3174
3790
 
3175
3791
  @UserStoreId.setter
@@ -3178,6 +3794,9 @@ class UpdateUserStatusRequest(AbstractModel):
3178
3794
 
3179
3795
  @property
3180
3796
  def UserId(self):
3797
+ """User ID
3798
+ :rtype: str
3799
+ """
3181
3800
  return self._UserId
3182
3801
 
3183
3802
  @UserId.setter
@@ -3186,6 +3805,13 @@ class UpdateUserStatusRequest(AbstractModel):
3186
3805
 
3187
3806
  @property
3188
3807
  def Status(self):
3808
+ """User status
3809
+
3810
+ <li> **NORMAL** </li> Normal
3811
+ <li> **LOCK** </li> Locked
3812
+ <li> **FREEZE** </li> Frozen
3813
+ :rtype: str
3814
+ """
3189
3815
  return self._Status
3190
3816
 
3191
3817
  @Status.setter
@@ -3221,6 +3847,9 @@ class UpdateUserStatusResponse(AbstractModel):
3221
3847
 
3222
3848
  @property
3223
3849
  def RequestId(self):
3850
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3851
+ :rtype: str
3852
+ """
3224
3853
  return self._RequestId
3225
3854
 
3226
3855
  @RequestId.setter
@@ -3403,6 +4032,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
3403
4032
 
3404
4033
  @property
3405
4034
  def UserId(self):
4035
+ """User ID
4036
+ :rtype: str
4037
+ """
3406
4038
  return self._UserId
3407
4039
 
3408
4040
  @UserId.setter
@@ -3411,6 +4043,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3411
4043
 
3412
4044
  @property
3413
4045
  def UserName(self):
4046
+ """Username
4047
+ Note: This field may return null, indicating that no valid values can be obtained.
4048
+ :rtype: str
4049
+ """
3414
4050
  return self._UserName
3415
4051
 
3416
4052
  @UserName.setter
@@ -3419,6 +4055,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3419
4055
 
3420
4056
  @property
3421
4057
  def PhoneNumber(self):
4058
+ """Mobile number
4059
+ Note: This field may return null, indicating that no valid values can be obtained.
4060
+ :rtype: str
4061
+ """
3422
4062
  return self._PhoneNumber
3423
4063
 
3424
4064
  @PhoneNumber.setter
@@ -3427,6 +4067,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3427
4067
 
3428
4068
  @property
3429
4069
  def Email(self):
4070
+ """Email address
4071
+ Note: This field may return null, indicating that no valid values can be obtained.
4072
+ :rtype: str
4073
+ """
3430
4074
  return self._Email
3431
4075
 
3432
4076
  @Email.setter
@@ -3435,6 +4079,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3435
4079
 
3436
4080
  @property
3437
4081
  def LastSignOn(self):
4082
+ """Last login time
4083
+ Note: This field may return null, indicating that no valid values can be obtained.
4084
+ :rtype: int
4085
+ """
3438
4086
  return self._LastSignOn
3439
4087
 
3440
4088
  @LastSignOn.setter
@@ -3443,6 +4091,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
3443
4091
 
3444
4092
  @property
3445
4093
  def CreatedDate(self):
4094
+ """Creation time
4095
+ :rtype: int
4096
+ """
3446
4097
  return self._CreatedDate
3447
4098
 
3448
4099
  @CreatedDate.setter
@@ -3451,6 +4102,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
3451
4102
 
3452
4103
  @property
3453
4104
  def Status(self):
4105
+ """Status
4106
+ :rtype: str
4107
+ """
3454
4108
  return self._Status
3455
4109
 
3456
4110
  @Status.setter
@@ -3459,6 +4113,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
3459
4113
 
3460
4114
  @property
3461
4115
  def UserDataSourceEnum(self):
4116
+ """User source
4117
+ :rtype: str
4118
+ """
3462
4119
  return self._UserDataSourceEnum
3463
4120
 
3464
4121
  @UserDataSourceEnum.setter
@@ -3467,6 +4124,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3467
4124
 
3468
4125
  @property
3469
4126
  def Nickname(self):
4127
+ """Nickname
4128
+ Note: This field may return null, indicating that no valid values can be obtained.
4129
+ :rtype: str
4130
+ """
3470
4131
  return self._Nickname
3471
4132
 
3472
4133
  @Nickname.setter
@@ -3475,6 +4136,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3475
4136
 
3476
4137
  @property
3477
4138
  def Address(self):
4139
+ """Address
4140
+ Note: This field may return null, indicating that no valid values can be obtained.
4141
+ :rtype: str
4142
+ """
3478
4143
  return self._Address
3479
4144
 
3480
4145
  @Address.setter
@@ -3483,6 +4148,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3483
4148
 
3484
4149
  @property
3485
4150
  def Birthdate(self):
4151
+ """Date of birth
4152
+ Note: This field may return null, indicating that no valid values can be obtained.
4153
+ :rtype: int
4154
+ """
3486
4155
  return self._Birthdate
3487
4156
 
3488
4157
  @Birthdate.setter
@@ -3491,6 +4160,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3491
4160
 
3492
4161
  @property
3493
4162
  def UserGroups(self):
4163
+ """User group ID
4164
+ Note: This field may return null, indicating that no valid values can be obtained.
4165
+ :rtype: list of str
4166
+ """
3494
4167
  return self._UserGroups
3495
4168
 
3496
4169
  @UserGroups.setter
@@ -3499,6 +4172,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3499
4172
 
3500
4173
  @property
3501
4174
  def LastModifiedDate(self):
4175
+ """Last modified time
4176
+ Note: This field may return null, indicating that no valid values can be obtained.
4177
+ :rtype: int
4178
+ """
3502
4179
  return self._LastModifiedDate
3503
4180
 
3504
4181
  @LastModifiedDate.setter
@@ -3507,6 +4184,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3507
4184
 
3508
4185
  @property
3509
4186
  def CustomAttributes(self):
4187
+ """Custom attribute
4188
+ Note: This field may return null, indicating that no valid values can be obtained.
4189
+ :rtype: list of MemberMap
4190
+ """
3510
4191
  return self._CustomAttributes
3511
4192
 
3512
4193
  @CustomAttributes.setter
@@ -3515,6 +4196,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3515
4196
 
3516
4197
  @property
3517
4198
  def ResidentIdentityCard(self):
4199
+ """ID card number
4200
+ Note: This field may return null, indicating that no valid values can be obtained.
4201
+ :rtype: str
4202
+ """
3518
4203
  return self._ResidentIdentityCard
3519
4204
 
3520
4205
  @ResidentIdentityCard.setter
@@ -3523,6 +4208,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3523
4208
 
3524
4209
  @property
3525
4210
  def QqOpenId(self):
4211
+ """`OpenId` on QQ
4212
+ Note: This field may return null, indicating that no valid values can be obtained.
4213
+ :rtype: str
4214
+ """
3526
4215
  return self._QqOpenId
3527
4216
 
3528
4217
  @QqOpenId.setter
@@ -3531,6 +4220,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3531
4220
 
3532
4221
  @property
3533
4222
  def QqUnionId(self):
4223
+ """`UnionId` on QQ
4224
+ Note: This field may return null, indicating that no valid values can be obtained.
4225
+ :rtype: str
4226
+ """
3534
4227
  return self._QqUnionId
3535
4228
 
3536
4229
  @QqUnionId.setter
@@ -3539,6 +4232,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3539
4232
 
3540
4233
  @property
3541
4234
  def WechatOpenId(self):
4235
+ """`WechatOpenId` on WeChat
4236
+ Note: This field may return null, indicating that no valid values can be obtained.
4237
+ :rtype: str
4238
+ """
3542
4239
  return self._WechatOpenId
3543
4240
 
3544
4241
  @WechatOpenId.setter
@@ -3547,6 +4244,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3547
4244
 
3548
4245
  @property
3549
4246
  def WechatUnionId(self):
4247
+ """`WechatUnionId` on WeChat
4248
+ Note: This field may return null, indicating that no valid values can be obtained.
4249
+ :rtype: str
4250
+ """
3550
4251
  return self._WechatUnionId
3551
4252
 
3552
4253
  @WechatUnionId.setter
@@ -3555,6 +4256,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3555
4256
 
3556
4257
  @property
3557
4258
  def AlipayUserId(self):
4259
+ """`AlipayUserId` on Alipay
4260
+ Note: This field may return null, indicating that no valid values can be obtained.
4261
+ :rtype: str
4262
+ """
3558
4263
  return self._AlipayUserId
3559
4264
 
3560
4265
  @AlipayUserId.setter
@@ -3563,6 +4268,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3563
4268
 
3564
4269
  @property
3565
4270
  def Description(self):
4271
+ """Description
4272
+ Note: This field may return null, indicating that no valid values can be obtained.
4273
+ :rtype: str
4274
+ """
3566
4275
  return self._Description
3567
4276
 
3568
4277
  @Description.setter
@@ -3571,6 +4280,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3571
4280
 
3572
4281
  @property
3573
4282
  def Name(self):
4283
+ """Name
4284
+ Note: This field may return null, indicating that no valid values can be obtained.
4285
+ :rtype: str
4286
+ """
3574
4287
  return self._Name
3575
4288
 
3576
4289
  @Name.setter
@@ -3579,6 +4292,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3579
4292
 
3580
4293
  @property
3581
4294
  def Locale(self):
4295
+ """Coordinate
4296
+ Note: This field may return null, indicating that no valid values can be obtained.
4297
+ :rtype: str
4298
+ """
3582
4299
  return self._Locale
3583
4300
 
3584
4301
  @Locale.setter
@@ -3587,6 +4304,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3587
4304
 
3588
4305
  @property
3589
4306
  def Gender(self):
4307
+ """Gender
4308
+ Note: This field may return null, indicating that no valid values can be obtained.
4309
+ :rtype: str
4310
+ """
3590
4311
  return self._Gender
3591
4312
 
3592
4313
  @Gender.setter
@@ -3595,6 +4316,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3595
4316
 
3596
4317
  @property
3597
4318
  def IdentityVerificationMethod(self):
4319
+ """Identity verification method
4320
+ Note: This field may return null, indicating that no valid values can be obtained.
4321
+ :rtype: str
4322
+ """
3598
4323
  return self._IdentityVerificationMethod
3599
4324
 
3600
4325
  @IdentityVerificationMethod.setter
@@ -3603,6 +4328,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3603
4328
 
3604
4329
  @property
3605
4330
  def IdentityVerified(self):
4331
+ """Whether the identity is verified
4332
+ Note: This field may return null, indicating that no valid values can be obtained.
4333
+ :rtype: bool
4334
+ """
3606
4335
  return self._IdentityVerified
3607
4336
 
3608
4337
  @IdentityVerified.setter
@@ -3611,6 +4340,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3611
4340
 
3612
4341
  @property
3613
4342
  def Job(self):
4343
+ """Job
4344
+ Note: This field may return null, indicating that no valid values can be obtained.
4345
+ :rtype: str
4346
+ """
3614
4347
  return self._Job
3615
4348
 
3616
4349
  @Job.setter
@@ -3619,6 +4352,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3619
4352
 
3620
4353
  @property
3621
4354
  def Nationality(self):
4355
+ """Country/Region
4356
+ Note: This field may return null, indicating that no valid values can be obtained.
4357
+ :rtype: str
4358
+ """
3622
4359
  return self._Nationality
3623
4360
 
3624
4361
  @Nationality.setter
@@ -3627,6 +4364,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3627
4364
 
3628
4365
  @property
3629
4366
  def Primary(self):
4367
+ """Whether the account is the primary account (after account merge, this parameter is `true` for primary accounts and `false` for secondary account).
4368
+ Note: This field may return null, indicating that no valid values can be obtained.
4369
+ :rtype: bool
4370
+ """
3630
4371
  return self._Primary
3631
4372
 
3632
4373
  @Primary.setter
@@ -3635,6 +4376,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3635
4376
 
3636
4377
  @property
3637
4378
  def Zone(self):
4379
+ """Time zone
4380
+ Note: This field may return null, indicating that no valid values can be obtained.
4381
+ :rtype: str
4382
+ """
3638
4383
  return self._Zone
3639
4384
 
3640
4385
  @Zone.setter
@@ -3643,6 +4388,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3643
4388
 
3644
4389
  @property
3645
4390
  def AlreadyFirstLogin(self):
4391
+ """Whether the account has ever logged in.
4392
+ Note: This field may return null, indicating that no valid values can be obtained.
4393
+ :rtype: bool
4394
+ """
3646
4395
  return self._AlreadyFirstLogin
3647
4396
 
3648
4397
  @AlreadyFirstLogin.setter
@@ -3651,6 +4400,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3651
4400
 
3652
4401
  @property
3653
4402
  def TenantId(self):
4403
+ """Tenant ID
4404
+ Note: This field may return null, indicating that no valid values can be obtained.
4405
+ :rtype: str
4406
+ """
3654
4407
  return self._TenantId
3655
4408
 
3656
4409
  @TenantId.setter
@@ -3659,6 +4412,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3659
4412
 
3660
4413
  @property
3661
4414
  def UserStoreId(self):
4415
+ """User directory ID
4416
+ Note: This field may return null, indicating that no valid values can be obtained.
4417
+ :rtype: str
4418
+ """
3662
4419
  return self._UserStoreId
3663
4420
 
3664
4421
  @UserStoreId.setter
@@ -3667,6 +4424,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3667
4424
 
3668
4425
  @property
3669
4426
  def Version(self):
4427
+ """Version
4428
+ Note: This field may return null, indicating that no valid values can be obtained.
4429
+ :rtype: int
4430
+ """
3670
4431
  return self._Version
3671
4432
 
3672
4433
  @Version.setter
@@ -3675,6 +4436,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3675
4436
 
3676
4437
  @property
3677
4438
  def LockType(self):
4439
+ """Lock type (locked by admin or locked by login policy)
4440
+ Note: This field may return null, indicating that no valid values can be obtained.
4441
+ :rtype: str
4442
+ """
3678
4443
  return self._LockType
3679
4444
 
3680
4445
  @LockType.setter
@@ -3683,6 +4448,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3683
4448
 
3684
4449
  @property
3685
4450
  def LockTime(self):
4451
+ """Lock time
4452
+ Note: This field may return null, indicating that no valid values can be obtained.
4453
+ :rtype: int
4454
+ """
3686
4455
  return self._LockTime
3687
4456
 
3688
4457
  @LockTime.setter
@@ -3691,6 +4460,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3691
4460
 
3692
4461
  @property
3693
4462
  def IndexedAttribute1(self):
4463
+ """Index field 1
4464
+ Note: this field may return null, indicating that no valid values can be obtained.
4465
+ :rtype: str
4466
+ """
3694
4467
  return self._IndexedAttribute1
3695
4468
 
3696
4469
  @IndexedAttribute1.setter
@@ -3699,6 +4472,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3699
4472
 
3700
4473
  @property
3701
4474
  def IndexedAttribute2(self):
4475
+ """Index field 2
4476
+ Note: this field may return null, indicating that no valid values can be obtained.
4477
+ :rtype: str
4478
+ """
3702
4479
  return self._IndexedAttribute2
3703
4480
 
3704
4481
  @IndexedAttribute2.setter
@@ -3707,6 +4484,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3707
4484
 
3708
4485
  @property
3709
4486
  def IndexedAttribute3(self):
4487
+ """Index field 3
4488
+ Note: this field may return null, indicating that no valid values can be obtained.
4489
+ :rtype: str
4490
+ """
3710
4491
  return self._IndexedAttribute3
3711
4492
 
3712
4493
  @IndexedAttribute3.setter
@@ -3715,6 +4496,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3715
4496
 
3716
4497
  @property
3717
4498
  def IndexedAttribute4(self):
4499
+ """Index field 4
4500
+ Note: this field may return null, indicating that no valid values can be obtained.
4501
+ :rtype: str
4502
+ """
3718
4503
  return self._IndexedAttribute4
3719
4504
 
3720
4505
  @IndexedAttribute4.setter
@@ -3723,6 +4508,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3723
4508
 
3724
4509
  @property
3725
4510
  def IndexedAttribute5(self):
4511
+ """Index field 5
4512
+ Note: this field may return null, indicating that no valid values can be obtained.
4513
+ :rtype: str
4514
+ """
3726
4515
  return self._IndexedAttribute5
3727
4516
 
3728
4517
  @IndexedAttribute5.setter