tccli 3.0.1214.1__py2.py3-none-any.whl → 3.0.1216.1__py2.py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (112) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/configure.py +46 -1
  3. tccli/services/__init__.py +0 -3
  4. tccli/services/ams/v20201229/examples.json +2 -2
  5. tccli/services/apm/v20210622/api.json +20 -0
  6. tccli/services/asr/v20190614/api.json +3 -3
  7. tccli/services/bi/v20220105/api.json +32 -4
  8. tccli/services/bi/v20220105/examples.json +1 -1
  9. tccli/services/billing/billing_client.py +53 -0
  10. tccli/services/billing/v20180709/api.json +304 -0
  11. tccli/services/billing/v20180709/examples.json +8 -0
  12. tccli/services/bsca/v20210811/api.json +222 -17
  13. tccli/services/bsca/v20210811/examples.json +4 -4
  14. tccli/services/ccc/ccc_client.py +53 -0
  15. tccli/services/ccc/v20200210/api.json +176 -18
  16. tccli/services/ccc/v20200210/examples.json +11 -3
  17. tccli/services/cdb/v20170320/api.json +22 -4
  18. tccli/services/cdb/v20170320/examples.json +1 -1
  19. tccli/services/cdn/v20180606/api.json +5 -3
  20. tccli/services/cdwdoris/v20211228/api.json +23 -2
  21. tccli/services/cfs/v20190719/api.json +3 -3
  22. tccli/services/cfw/v20190904/api.json +86 -52
  23. tccli/services/cfw/v20190904/examples.json +68 -56
  24. tccli/services/ciam/v20220331/api.json +316 -315
  25. tccli/services/ciam/v20220331/examples.json +49 -49
  26. tccli/services/ckafka/v20190819/api.json +1 -1
  27. tccli/services/cloudaudit/cloudaudit_client.py +30 -30
  28. tccli/services/cloudaudit/v20190319/api.json +215 -186
  29. tccli/services/cloudaudit/v20190319/examples.json +13 -13
  30. tccli/services/cls/v20201016/api.json +365 -66
  31. tccli/services/cls/v20201016/examples.json +9 -3
  32. tccli/services/csip/v20221121/api.json +4 -4
  33. tccli/services/cvm/v20170312/api.json +42 -0
  34. tccli/services/cwp/v20180228/api.json +865 -809
  35. tccli/services/cwp/v20180228/examples.json +98 -110
  36. tccli/services/cynosdb/v20190107/api.json +77 -29
  37. tccli/services/cynosdb/v20190107/examples.json +22 -22
  38. tccli/services/dasb/v20191018/api.json +77 -0
  39. tccli/services/dasb/v20191018/examples.json +5 -5
  40. tccli/services/dbbrain/v20191016/examples.json +1 -1
  41. tccli/services/dlc/v20210125/api.json +11 -0
  42. tccli/services/domain/v20180808/api.json +3 -3
  43. tccli/services/domain/v20180808/examples.json +3 -3
  44. tccli/services/eb/v20210416/api.json +15 -15
  45. tccli/services/eb/v20210416/examples.json +1 -1
  46. tccli/services/emr/v20190103/api.json +9 -0
  47. tccli/services/es/es_client.py +249 -37
  48. tccli/services/es/v20180416/api.json +521 -0
  49. tccli/services/es/v20180416/examples.json +32 -0
  50. tccli/services/ess/ess_client.py +53 -0
  51. tccli/services/ess/v20201111/api.json +155 -10
  52. tccli/services/ess/v20201111/examples.json +15 -1
  53. tccli/services/essbasic/essbasic_client.py +106 -0
  54. tccli/services/essbasic/v20210526/api.json +244 -13
  55. tccli/services/essbasic/v20210526/examples.json +22 -0
  56. tccli/services/gaap/v20180529/api.json +44 -26
  57. tccli/services/gaap/v20180529/examples.json +24 -30
  58. tccli/services/hunyuan/v20230901/examples.json +6 -0
  59. tccli/services/iotexplorer/v20190423/api.json +40 -0
  60. tccli/services/iss/v20230517/api.json +19 -0
  61. tccli/services/live/v20180801/api.json +35 -9
  62. tccli/services/mongodb/v20190725/api.json +6 -8
  63. tccli/services/mqtt/v20240516/api.json +2 -2
  64. tccli/services/mqtt/v20240516/examples.json +1 -1
  65. tccli/services/ocr/v20181119/api.json +2 -2
  66. tccli/services/organization/organization_client.py +352 -34
  67. tccli/services/organization/v20210331/api.json +451 -0
  68. tccli/services/organization/v20210331/examples.json +48 -0
  69. tccli/services/partners/partners_client.py +57 -4
  70. tccli/services/partners/v20180321/api.json +44 -0
  71. tccli/services/partners/v20180321/examples.json +8 -0
  72. tccli/services/region/v20220627/api.json +1 -1
  73. tccli/services/scf/scf_client.py +269 -4
  74. tccli/services/scf/v20180416/api.json +554 -0
  75. tccli/services/scf/v20180416/examples.json +46 -0
  76. tccli/services/ssl/v20191205/api.json +34 -5
  77. tccli/services/tat/v20201028/api.json +27 -25
  78. tccli/services/tat/v20201028/examples.json +4 -4
  79. tccli/services/tcss/v20201101/api.json +256 -14
  80. tccli/services/tcss/v20201101/examples.json +7 -7
  81. tccli/services/tdmq/v20200217/api.json +64 -63
  82. tccli/services/tdmq/v20200217/examples.json +2 -2
  83. tccli/services/tem/v20210701/api.json +144 -103
  84. tccli/services/tem/v20210701/examples.json +27 -27
  85. tccli/services/teo/teo_client.py +277 -12
  86. tccli/services/teo/v20220901/api.json +1023 -146
  87. tccli/services/teo/v20220901/examples.json +71 -1
  88. tccli/services/tke/tke_client.py +53 -0
  89. tccli/services/tke/v20180525/api.json +43 -0
  90. tccli/services/tke/v20180525/examples.json +8 -0
  91. tccli/services/tms/tms_client.py +4 -57
  92. tccli/services/tms/v20201229/api.json +0 -354
  93. tccli/services/tms/v20201229/examples.json +0 -8
  94. tccli/services/trtc/v20190722/api.json +221 -22
  95. tccli/services/vpc/v20170312/api.json +111 -34
  96. tccli/services/vpc/v20170312/examples.json +11 -3
  97. tccli/services/vpc/vpc_client.py +107 -54
  98. tccli/services/waf/v20180125/api.json +61 -0
  99. tccli/services/waf/v20180125/examples.json +8 -0
  100. tccli/services/waf/waf_client.py +53 -0
  101. tccli/services/wedata/v20210820/api.json +686 -0
  102. tccli/services/wedata/v20210820/examples.json +16 -0
  103. tccli/services/wedata/wedata_client.py +106 -0
  104. {tccli-3.0.1214.1.dist-info → tccli-3.0.1216.1.dist-info}/METADATA +6 -2
  105. {tccli-3.0.1214.1.dist-info → tccli-3.0.1216.1.dist-info}/RECORD +108 -112
  106. tccli/services/cr/__init__.py +0 -4
  107. tccli/services/cr/cr_client.py +0 -1626
  108. tccli/services/cr/v20180321/api.json +0 -2829
  109. tccli/services/cr/v20180321/examples.json +0 -235
  110. {tccli-3.0.1214.1.dist-info → tccli-3.0.1216.1.dist-info}/WHEEL +0 -0
  111. {tccli-3.0.1214.1.dist-info → tccli-3.0.1216.1.dist-info}/entry_points.txt +0 -0
  112. {tccli-3.0.1214.1.dist-info → tccli-3.0.1216.1.dist-info}/license_files/LICENSE +0 -0
@@ -2,129 +2,129 @@
2
2
  "actions": {
3
3
  "CreateApiImportUserJob": [
4
4
  {
5
- "document": "",
6
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApiImportUserJob\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"DataFlowUserCreateList\": [\n {\n \"UserName\": \"xx\",\n \"Zone\": \"xx\",\n \"ResidentIdentityCard\": \"xx\",\n \"WechatOpenId\": \"xx\",\n \"Email\": \"xx\",\n \"CustomizationAttributes\": [\n {\n \"Type\": \"xx\",\n \"Name\": \"xx\",\n \"Value\": \"xx\"\n }\n ],\n \"Description\": \"xx\",\n \"Job\": \"xx\",\n \"Address\": \"xx\",\n \"Nationality\": \"xx\",\n \"Password\": \"xx\",\n \"Nickname\": \"xx\",\n \"QqOpenId\": \"xx\",\n \"Name\": \"xx\",\n \"Gender\": \"xx\",\n \"IdentityVerificationMethod\": \"xx\",\n \"AlipayUserId\": \"xx\",\n \"Birthdate\": \"2020-09-22\",\n \"PhoneNumber\": \"xx\",\n \"UserGroup\": [\n \"xx\"\n ],\n \"PasswordEncryptTypeEnum\": \"xx\",\n \"Salt\": {\n \"SaltLocation\": {\n \"SaltLocationRule\": {\n \"Regex\": \"xx\"\n },\n \"SaltLocationTypeEnum\": \"xx\"\n },\n \"SaltValue\": \"xx\"\n },\n \"QqUnionId\": \"xx\",\n \"Locale\": \"xx\",\n \"IdentityVerified\": true,\n \"WechatUnionId\": \"xx\"\n }\n ]\n}",
7
- "output": "{\n \"Response\": {\n \"Job\": {\n \"Status\": \"xx\",\n \"Format\": \"xx\",\n \"ErrorDetails\": [\n {\n \"UserId\": \"xx\",\n \"Error\": \"xx\"\n }\n ],\n \"Location\": \"xx\",\n \"CreatedDate\": 0,\n \"FailedUsers\": [\n {\n \"FailedUserIdentification\": \"xx\",\n \"FailedReason\": \"xx\"\n }\n ],\n \"Type\": \"xx\",\n \"Id\": \"xx\"\n },\n \"RequestId\": \"xx\"\n }\n}",
5
+ "document": "批量导入用户时使用",
6
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateApiImportUserJob\n<公共请求参数>\n\n{\n \"UserStoreId\": \"abc\",\n \"DataFlowUserCreateList\": [\n {\n \"UserName\": \"zhangsan\",\n \"PhoneNumber\": \"132****0000\",\n \"Email\": \"132****@qq.com\",\n \"ResidentIdentityCard\": \"123456789012345678\",\n \"Nickname\": \"昵称1\",\n \"Address\": \"北京市海淀区\",\n \"UserGroup\": [\n \"6cd22e51****************f6f7cb81\"\n ],\n \"QqOpenId\": \"qqopenid\",\n \"QqUnionId\": \"qqunionid\",\n \"WechatOpenId\": \"wechatopenid\",\n \"WechatUnionId\": \"wechatunionid\",\n \"AlipayUserId\": \"alipayuserid\",\n \"WeComUserId\": \"wecomuserid\",\n \"Description\": \"用户1\",\n \"Birthdate\": \"2022-10-20\",\n \"Name\": \"姓名\",\n \"Locale\": \"地理位置\",\n \"Gender\": \"男\",\n \"IdentityVerificationMethod\": \"无\",\n \"IdentityVerified\": true,\n \"Job\": \"员工\",\n \"Nationality\": \"汉族\",\n \"Zone\": \"时区\",\n \"Password\": \"password\",\n \"CustomizationAttributes\": [\n {\n \"Name\": \"nickname\",\n \"Value\": \"昵称\",\n \"Type\": \"STRING\"\n }\n ],\n \"Salt\": {\n \"SaltValue\": \"salt***\",\n \"SaltLocation\": {\n \"SaltLocationTypeEnum\": \"HEAD\",\n \"SaltLocationRule\": {\n \"Regex\": \"passwordabc123\"\n }\n }\n },\n \"PasswordEncryptTypeEnum\": \"SHA1\",\n \"IndexedAttribute1\": \"value1\",\n \"IndexedAttribute2\": \"value2\",\n \"IndexedAttribute3\": \"value3\",\n \"IndexedAttribute4\": \"value4\",\n \"IndexedAttribute5\": \"value5\"\n }\n ]\n}",
7
+ "output": "{\n \"Response\": {\n \"Job\": {\n \"Id\": \"c29f2c0f****************405ec698\",\n \"Status\": \"PENDING\",\n \"Type\": \"IMPORT_USER\",\n \"CreatedDate\": 1715156770024,\n \"Format\": \"NDJSON\",\n \"Location\": \"http://aa.com/bb.csv\",\n \"ErrorDetails\": [\n {\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"Error\": \"error message\"\n }\n ],\n \"FailedUsers\": [\n {\n \"FailedUserIdentification\": \"53e25c3****************e4eb5bd1\",\n \"FailedReason\": \"error reason\"\n }\n ]\n },\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
8
8
  "title": "新建接口导入用户任务"
9
9
  }
10
10
  ],
11
11
  "CreateFileExportUserJob": [
12
12
  {
13
13
  "document": "",
14
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFileExportUserJob\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"ExportPropertyMaps\": [\n {\n \"ColumnName\": \"xx\",\n \"UserPropertyCode\": \"xx\"\n }\n ],\n \"Filters\": [\n {\n \"Values\": [\n \"xx\"\n ],\n \"Key\": \"xx\",\n \"Logic\": true\n }\n ],\n \"Format\": \"xx\"\n}",
15
- "output": "{\n \"Response\": {\n \"Job\": {\n \"Status\": \"xx\",\n \"Format\": \"xx\",\n \"ErrorDetails\": [\n {\n \"UserId\": \"xx\",\n \"Error\": \"xx\"\n }\n ],\n \"Location\": \"xx\",\n \"CreatedDate\": 0,\n \"FailedUsers\": [\n {\n \"FailedUserIdentification\": \"xx\",\n \"FailedReason\": \"xx\"\n }\n ],\n \"Type\": \"xx\",\n \"Id\": \"xx\"\n },\n \"RequestId\": \"xx\"\n }\n}",
14
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateFileExportUserJob\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"Format\": \"NDJSON\",\n \"Filters\": [\n {\n \"Key\": \"local\",\n \"Values\": [\n \"beijing\"\n ],\n \"Logic\": true\n }\n ],\n \"ExportPropertyMaps\": [\n {\n \"UserPropertyCode\": \"nickname\",\n \"ColumnName\": \"昵称\"\n }\n ]\n}",
15
+ "output": "{\n \"Response\": {\n \"Job\": {\n \"Id\": \"c29f2c0f****************405ec698\",\n \"Status\": \"PENDING\",\n \"Type\": \"IMPORT_USER\",\n \"CreatedDate\": 1715156770024,\n \"Format\": \"NDJSON\",\n \"Location\": \"http://aa.com/bb.csv\",\n \"ErrorDetails\": [\n {\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"Error\": \"error message\"\n }\n ],\n \"FailedUsers\": [\n {\n \"FailedUserIdentification\": \"53e25c3****************e4eb5bd1\",\n \"FailedReason\": \"error reason\"\n }\n ]\n },\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
16
16
  "title": "新建文件导出用户任务"
17
17
  }
18
18
  ],
19
19
  "CreateUser": [
20
20
  {
21
- "document": "",
22
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUser\n<公共请求参数>\n\n{\n \"UserName\": \"xx\",\n \"UserStoreId\": \"xx\",\n \"UserGroup\": [\n \"xxx\"\n ],\n \"Birthdate\": 0,\n \"PhoneNumber\": \"xx\",\n \"Address\": \"xx\",\n \"Password\": \"xx\",\n \"Nickname\": \"xx\",\n \"Email\": \"xx\",\n \"CustomizationAttributes\": [\n {\n \"Name\": \"xx\",\n \"Value\": \"xx\"\n }\n ]\n}",
23
- "output": "{\n \"Response\": {\n \"RequestId\": \"xxx\",\n \"User\": null\n }\n}",
21
+ "document": "创建用户时使用",
22
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUser\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"PhoneNumber\": \"132****0000\",\n \"Email\": \"132****@qq.com\",\n \"Password\": \"password\",\n \"Nickname\": \"昵称1\",\n \"Address\": \"北京市海淀区\",\n \"UserGroup\": [\n \"6cd22e51****************f6f7cb81\"\n ],\n \"Birthdate\": 1706682491339,\n \"CustomizationAttributes\": [\n {\n \"Name\": \"k\",\n \"Value\": \"v\",\n \"Type\": \"STRING\"\n }\n ],\n \"UserName\": \"zhangsan\",\n \"IndexedAttribute1\": \"value1\",\n \"IndexedAttribute2\": \"value2\",\n \"IndexedAttribute3\": \"value3\",\n \"IndexedAttribute4\": \"value4\",\n \"IndexedAttribute5\": \"value5\"\n}",
23
+ "output": "{\n \"Response\": {\n \"User\": {\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"UserName\": \"zhangsan\",\n \"PhoneNumber\": \"132****0000\",\n \"Email\": \"132****@qq.com\",\n \"LastSignOn\": 1711002933442,\n \"CreatedDate\": 1718332940956,\n \"Status\": \"NORMAL\",\n \"UserDataSourceEnum\": \"管理员添加\",\n \"Nickname\": \"昵称1\",\n \"Address\": \"北京市海淀区\",\n \"Birthdate\": 1706682491339,\n \"UserGroups\": [\n \"6cd22e51****************f6f7cb81\"\n ],\n \"LastModifiedDate\": 1722420973329,\n \"CustomAttributes\": [\n {\n \"Name\": \"k\",\n \"Value\": \"v\",\n \"Type\": \"STRING\"\n }\n ],\n \"ResidentIdentityCard\": \"123456789012345678\",\n \"QqOpenId\": \"qqopenid\",\n \"QqUnionId\": \"qqunionid\",\n \"WechatOpenId\": \"wechatopenid\",\n \"WechatUnionId\": \"wechatunionid\",\n \"AlipayUserId\": \"alipayuserid\",\n \"WeComUserId\": \"wecomuserid\",\n \"Description\": \"用户1\",\n \"Name\": \"姓名\",\n \"Locale\": \"地理位置\",\n \"Gender\": \"男\",\n \"IdentityVerificationMethod\": \"-\",\n \"IdentityVerified\": true,\n \"Job\": \"员工\",\n \"Nationality\": \"汉族\",\n \"Primary\": true,\n \"Zone\": \"时区\",\n \"AlreadyFirstLogin\": true,\n \"TenantId\": \"tenantId\",\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"Version\": 0,\n \"LockType\": \"-\",\n \"LockTime\": 0,\n \"IndexedAttribute1\": \"value1\",\n \"IndexedAttribute2\": \"value2\",\n \"IndexedAttribute3\": \"value3\",\n \"IndexedAttribute4\": \"value4\",\n \"IndexedAttribute5\": \"value5\"\n },\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
24
24
  "title": "创建用户"
25
25
  }
26
26
  ],
27
27
  "CreateUserGroup": [
28
28
  {
29
29
  "document": "创建用户组",
30
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUserGroup\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xxx\",\n \"DisplayName\": \"xxx\",\n \"Description\": \"xxx\"\n}",
31
- "output": "{\n \"Response\": {\n \"RequestId\": \"xxx\",\n \"UserGroupId\": \"xxx\"\n }\n}",
30
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUserGroup\n<公共请求参数>\n\n{\n \"DisplayName\": \"用户组1\",\n \"Description\": \"包含了一组用户\",\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\"\n}",
31
+ "output": "{\n \"Response\": {\n \"UserGroupId\": \"6cd22e51****************f6f7cb81\",\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
32
32
  "title": "创建用户组"
33
33
  }
34
34
  ],
35
35
  "CreateUserStore": [
36
36
  {
37
37
  "document": "创建用户目录",
38
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUserStore\n<公共请求参数>\n\n{\n \"UserPoolName\": \"abc\",\n \"UserPoolDesc\": \"abc\",\n \"UserPoolLogo\": \"abc\"\n}",
39
- "output": "{\n \"Response\": {\n \"RequestId\": \"abc\",\n \"UserStoreId\": \"abc\"\n }\n}",
38
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateUserStore\n<公共请求参数>\n\n{\n \"UserPoolName\": \"目录1\",\n \"UserPoolDesc\": \"管理应用和用户\",\n \"UserPoolLogo\": \"https://aa.com/bb.png\"\n}",
39
+ "output": "{\n \"Response\": {\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
40
40
  "title": "创建用户目录"
41
41
  }
42
42
  ],
43
43
  "DeleteUserGroups": [
44
44
  {
45
45
  "document": "",
46
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteUserGroups\n<公共请求参数>\n\n{\n \"UserGroupIds\": [\n \"xxx\"\n ],\n \"UserStoreId\": \"xxx\"\n}",
47
- "output": "{\n \"Response\": {\n \"UserGroupDeletedInfo\": {\n \"AppAssociatedUserGroupIds\": [\n {\n \"ApplicationName\": \"xx\",\n \"ApplicationId\": \"xx\",\n \"UserGroupId\": \"xx\"\n }\n ]\n },\n \"RequestId\": \"xx\"\n }\n}",
46
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteUserGroups\n<公共请求参数>\n\n{\n \"UserGroupIds\": [\n \"6cd22e51****************f6f7cb81\"\n ],\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\"\n}",
47
+ "output": "{\n \"Response\": {\n \"UserGroupDeletedInfo\": {\n \"ErrorMessage\": \"error message\",\n \"AppAssociatedUserGroupIds\": [\n {\n \"UserGroupId\": \"6cd22e51****************f6f7cb81\",\n \"ApplicationId\": \"17c29b8c****************c0228c48\",\n \"ApplicationName\": \"应用1\"\n }\n ]\n },\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
48
48
  "title": "批量删除用户组"
49
49
  }
50
50
  ],
51
51
  "DeleteUserStore": [
52
52
  {
53
53
  "document": "",
54
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteUserStore\n<公共请求参数>\n\n{\n \"UserPoolId\": \"xx\"\n}",
55
- "output": "{\n \"Response\": {\n \"RequestId\": \"xx\"\n }\n}",
54
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteUserStore\n<公共请求参数>\n\n{\n \"UserPoolId\": \"2c3aca3b****************a7efe88e\"\n}",
55
+ "output": "{\n \"Response\": {\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
56
56
  "title": "删除用户目录"
57
57
  }
58
58
  ],
59
59
  "DeleteUsers": [
60
60
  {
61
61
  "document": "",
62
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteUsers\n<公共请求参数>\n\n{\n \"UserIds\": [\n \"xxx\"\n ],\n \"UserStoreId\": \"xxx\"\n}",
63
- "output": "{\n \"Response\": {\n \"RequestId\": \"xxx\"\n }\n}",
62
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteUsers\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"UserIds\": [\n \"53e25c3****************e4eb5bd1\"\n ]\n}",
63
+ "output": "{\n \"Response\": {\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
64
64
  "title": "批量删除用户"
65
65
  }
66
66
  ],
67
67
  "DescribeUser": [
68
68
  {
69
69
  "document": "",
70
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUser\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"Pageable\": {\n \"PageNumber\": 0,\n \"PageSize\": 0\n },\n \"Filters\": [\n {\n \"PropertyKey\": \"xx\",\n \"PropertyValue\": \"xx\",\n \"Logic\": true\n }\n ]\n}",
71
- "output": "{\n \"Response\": {\n \"Content\": [\n {\n \"UserName\": \"xx\",\n \"Zone\": \"xx\",\n \"ResidentIdentityCard\": \"xx\",\n \"TenantId\": \"xx\",\n \"WechatOpenId\": \"xx\",\n \"Email\": \"xx\",\n \"Status\": \"xx\",\n \"Description\": \"xx\",\n \"UserId\": \"xx\",\n \"Job\": \"xx\",\n \"Address\": \"xx\",\n \"Nationality\": \"xx\",\n \"Nickname\": \"xx\",\n \"UserStoreId\": \"xx\",\n \"QqOpenId\": \"xx\",\n \"Name\": \"xx\",\n \"Gender\": \"xx\",\n \"IdentityVerificationMethod\": \"xx\",\n \"AlipayUserId\": \"xx\",\n \"LastSignOn\": \"xx\",\n \"PhoneNumber\": \"xx\",\n \"QqUnionId\": \"xx\",\n \"Locale\": \"xx\",\n \"Primary\": true,\n \"IdentityVerified\": true,\n \"WechatUnionId\": \"xx\"\n }\n ],\n \"Total\": 0,\n \"Pageable\": {\n \"PageNumber\": 0,\n \"PageSize\": 0\n },\n \"RequestId\": \"xx\"\n }\n}",
70
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUser\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"Pageable\": {\n \"PageSize\": 10,\n \"PageNumber\": 5\n },\n \"Filters\": [\n {\n \"PropertyKey\": \"nickname\",\n \"PropertyValue\": \"昵称1\",\n \"Logic\": true,\n \"OperateLogic\": \"abc\"\n }\n ],\n \"Original\": true,\n \"Sort\": {\n \"PropertyKey\": \"nickname\",\n \"Order\": \"decs\"\n }\n}",
71
+ "output": "{\n \"Response\": {\n \"Total\": 100,\n \"Pageable\": {\n \"PageSize\": 10,\n \"PageNumber\": 5\n },\n \"Content\": [\n {\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"UserName\": \"zhangsan\",\n \"PhoneNumber\": \"132****0000\",\n \"Email\": \"132****@qq.com\",\n \"LastSignOn\": 1711002933442,\n \"CreatedDate\": 1718332940956,\n \"Status\": \"NORMAL\",\n \"UserDataSourceEnum\": \"管理员添加\",\n \"Nickname\": \"昵称1\",\n \"Address\": \"北京市海淀区\",\n \"Birthdate\": 1706682491339,\n \"UserGroups\": [\n \"6cd22e51****************f6f7cb81\"\n ],\n \"LastModifiedDate\": 1722420973329,\n \"CustomAttributes\": [\n {\n \"Name\": \"k\",\n \"Value\": \"v\",\n \"Type\": \"STRING\"\n }\n ],\n \"ResidentIdentityCard\": \"123456789012345678\",\n \"QqOpenId\": \"qqopenid\",\n \"QqUnionId\": \"qqunionid\",\n \"WechatOpenId\": \"wechatopenid\",\n \"WechatUnionId\": \"wechatunionid\",\n \"AlipayUserId\": \"alipayuserid\",\n \"WeComUserId\": \"wecomuserid\",\n \"Description\": \"用户1\",\n \"Name\": \"姓名\",\n \"Locale\": \"地理位置\",\n \"Gender\": \"男\",\n \"IdentityVerificationMethod\": \"-\",\n \"IdentityVerified\": true,\n \"Job\": \"员工\",\n \"Nationality\": \"汉族\",\n \"Primary\": true,\n \"Zone\": \"时区\",\n \"AlreadyFirstLogin\": true,\n \"TenantId\": \"tenantId\",\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"Version\": 0,\n \"LockType\": \"-\",\n \"LockTime\": 0,\n \"IndexedAttribute1\": \"value1\",\n \"IndexedAttribute2\": \"value2\",\n \"IndexedAttribute3\": \"value3\",\n \"IndexedAttribute4\": \"value4\",\n \"IndexedAttribute5\": \"value5\"\n }\n ],\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
72
72
  "title": "查询用户信息"
73
73
  }
74
74
  ],
75
75
  "DescribeUserById": [
76
76
  {
77
- "document": "",
78
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUserById\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"UserId\": \"xx\"\n}",
79
- "output": "{\n \"Response\": {\n \"User\": {\n \"UserName\": \"xx\",\n \"Zone\": \"xx\",\n \"UserId\": \"xx\",\n \"ResidentIdentityCard\": \"xx\",\n \"TenantId\": \"xx\",\n \"CustomAttributes\": [\n {\n \"Type\": \"xx\",\n \"Name\": \"xx\",\n \"Value\": \"xx\"\n }\n ],\n \"Version\": 0,\n \"WechatOpenId\": \"xx\",\n \"Email\": \"xx\",\n \"Status\": \"xx\",\n \"Description\": \"xx\",\n \"LastModifiedDate\": 0,\n \"AlreadyFirstLogin\": true,\n \"Job\": \"xx\",\n \"Address\": \"xx\",\n \"Nationality\": \"xx\",\n \"Nickname\": \"xx\",\n \"UserStoreId\": \"xx\",\n \"QqOpenId\": \"xx\",\n \"Name\": \"xx\",\n \"UserDataSourceEnum\": \"xx\",\n \"Gender\": \"xx\",\n \"IdentityVerificationMethod\": \"xx\",\n \"AlipayUserId\": \"xx\",\n \"LastSignOn\": 0,\n \"PhoneNumber\": \"xx\",\n \"Birthdate\": 0,\n \"QqUnionId\": \"xx\",\n \"UserGroups\": [\n \"xx\"\n ],\n \"Locale\": \"xx\",\n \"Primary\": true,\n \"IdentityVerified\": true,\n \"CreatedDate\": 0,\n \"LockTime\": 0,\n \"LockType\": \"xx\",\n \"WechatUnionId\": \"xx\"\n },\n \"RequestId\": \"xx\"\n }\n}",
77
+ "document": "根据用户ID查询用户信息时使用",
78
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeUserById\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"Original\": true\n}",
79
+ "output": "{\n \"Response\": {\n \"User\": {\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"UserName\": \"zhangsan\",\n \"PhoneNumber\": \"132****0000\",\n \"Email\": \"132****@qq.com\",\n \"LastSignOn\": 1711002933442,\n \"CreatedDate\": 1718332940956,\n \"Status\": \"NORMAL\",\n \"UserDataSourceEnum\": \"管理员添加\",\n \"Nickname\": \"昵称1\",\n \"Address\": \"北京市海淀区\",\n \"Birthdate\": 1706682491339,\n \"UserGroups\": [\n \"6cd22e51****************f6f7cb81\"\n ],\n \"LastModifiedDate\": 1722420973329,\n \"CustomAttributes\": [\n {\n \"Name\": \"k\",\n \"Value\": \"v\",\n \"Type\": \"STRING\"\n }\n ],\n \"ResidentIdentityCard\": \"123456789012345678\",\n \"QqOpenId\": \"qqopenid\",\n \"QqUnionId\": \"qqunionid\",\n \"WechatOpenId\": \"wechatopenid\",\n \"WechatUnionId\": \"wechatunionid\",\n \"AlipayUserId\": \"alipayuserid\",\n \"WeComUserId\": \"wecomuserid\",\n \"Description\": \"用户1\",\n \"Name\": \"姓名\",\n \"Locale\": \"地理位置\",\n \"Gender\": \"男\",\n \"IdentityVerificationMethod\": \"-\",\n \"IdentityVerified\": true,\n \"Job\": \"员工\",\n \"Nationality\": \"汉族\",\n \"Primary\": true,\n \"Zone\": \"时区\",\n \"AlreadyFirstLogin\": true,\n \"TenantId\": \"tenantId\",\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"Version\": 0,\n \"LockType\": \"-\",\n \"LockTime\": 0,\n \"IndexedAttribute1\": \"value1\",\n \"IndexedAttribute2\": \"value2\",\n \"IndexedAttribute3\": \"value3\",\n \"IndexedAttribute4\": \"value4\",\n \"IndexedAttribute5\": \"value5\"\n },\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
80
80
  "title": "根据ID查询用户信息"
81
81
  }
82
82
  ],
83
83
  "LinkAccount": [
84
84
  {
85
85
  "document": "",
86
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: LinkAccount\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"PrimaryUserId\": \"xx\",\n \"UserLinkedOnAttribute\": \"xx\",\n \"SecondaryUserId\": \"xx\"\n}",
87
- "output": "{\n \"Response\": {\n \"RequestId\": \"xx\"\n }\n}",
86
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: LinkAccount\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"PrimaryUserId\": \"53e25c3****************e4eb5bd1\",\n \"SecondaryUserId\": \"081820ad****************5c58d1ad\",\n \"UserLinkedOnAttribute\": \"PHONENUMBER\"\n}",
87
+ "output": "{\n \"Response\": {\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
88
88
  "title": "账号融合"
89
89
  }
90
90
  ],
91
91
  "ListJobs": [
92
92
  {
93
93
  "document": "",
94
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListJobs\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"JobIds\": [\n \"xx\"\n ]\n}",
95
- "output": "{\n \"Response\": {\n \"JobSet\": [\n {\n \"Status\": \"xx\",\n \"Format\": \"xx\",\n \"FailedUsers\": [\n {\n \"FailedUserIdentification\": \"xx\",\n \"FailedReason\": \"xx\"\n }\n ],\n \"Location\": \"xx\",\n \"Type\": \"xx\",\n \"Id\": \"xx\"\n }\n ],\n \"RequestId\": \"xx\"\n }\n}",
94
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListJobs\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"JobIds\": [\n \"c29f2c0f****************405ec698\"\n ]\n}",
95
+ "output": "{\n \"Response\": {\n \"JobSet\": [\n {\n \"Id\": \"c29f2c0f****************405ec698\",\n \"Status\": \"PENDING\",\n \"Type\": \"IMPORT_USER\",\n \"CreatedDate\": 1715156770024,\n \"Format\": \"NDJSON\",\n \"Location\": \"http://aa.com/bb.csv\",\n \"ErrorDetails\": [\n {\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"Error\": \"error message\"\n }\n ],\n \"FailedUsers\": [\n {\n \"FailedUserIdentification\": \"53e25c3****************e4eb5bd1\",\n \"FailedReason\": \"error reason\"\n }\n ]\n }\n ],\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
96
96
  "title": "查询任务详情"
97
97
  }
98
98
  ],
99
99
  "ListLogMessageByCondition": [
100
100
  {
101
101
  "document": "",
102
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListLogMessageByCondition\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"StartTime\": 0,\n \"Pageable\": {\n \"PageNumber\": 0,\n \"PageSize\": 0\n },\n \"Filters\": [\n {\n \"Values\": [\n \"xx\"\n ],\n \"Key\": \"xx\",\n \"Logic\": true\n }\n ]\n}",
103
- "output": "{\n \"Response\": {\n \"Content\": [\n {\n \"UserStoreId\": \"xx\",\n \"ApplicationName\": \"xx\",\n \"Participant\": \"xx\",\n \"Description\": \"xx\",\n \"EventCode\": \"xx\",\n \"Ip\": \"xx\",\n \"ApplicationClientId\": \"xx\",\n \"UserId\": \"xx\",\n \"Detail\": \"xx\",\n \"AuthSourceName\": \"xx\",\n \"TenantId\": \"xx\",\n \"LogId\": \"xx\",\n \"AuthSourceId\": \"xx\",\n \"AuthSourceType\": \"xx\",\n \"UserAgent\": \"xx\",\n \"AuthSourceCategory\": \"xx\",\n \"EventDate\": 0\n }\n ],\n \"Total\": 0,\n \"Pageable\": {\n \"PageNumber\": 0,\n \"PageSize\": 0\n },\n \"RequestId\": \"xx\"\n }\n}",
102
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListLogMessageByCondition\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"Pageable\": {\n \"PageSize\": 10,\n \"PageNumber\": 5\n },\n \"Filters\": [\n {\n \"Key\": \"nickname\",\n \"Values\": [\n \"昵称1\"\n ],\n \"Logic\": true\n }\n ],\n \"StartTime\": 1703385600000\n}",
103
+ "output": "{\n \"Response\": {\n \"Total\": 100,\n \"Pageable\": {\n \"PageSize\": 10,\n \"PageNumber\": 5\n },\n \"Content\": [\n {\n \"LogId\": \"a23039fd****************44a78adc\",\n \"TenantId\": \"tenantId\",\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"EventCode\": \"FORGET_USERNAME\",\n \"EventDate\": 1703385600000,\n \"Description\": \"忘记用户名日志\",\n \"Participant\": \"TENANT\",\n \"ApplicationClientId\": \"YmFiZTk5********3ZGZiZmY\",\n \"ApplicationName\": \"应用1\",\n \"AuthSourceId\": \"5c7df28a********2a3dbbae\",\n \"AuthSourceName\": \"账号密码认证源1\",\n \"AuthSourceType\": \"USERNAME_PASSWORD\",\n \"AuthSourceCategory\": \"UNIVERSAL\",\n \"Ip\": \"127.*.*.1\",\n \"UserAgent\": \"agent1\",\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"Detail\": \"error detail\",\n \"ActionResult\": \"FAIL\"\n }\n ],\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
104
104
  "title": "查询日志信息"
105
105
  }
106
106
  ],
107
107
  "ListUser": [
108
108
  {
109
109
  "document": "",
110
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListUser\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"Pageable\": {\n \"PageNumber\": 0,\n \"PageSize\": 0\n },\n \"Filters\": [\n {\n \"Values\": [\n \"xx\"\n ],\n \"Key\": \"xx\",\n \"Logic\": true\n }\n ]\n}",
111
- "output": "{\n \"Response\": {\n \"Content\": [\n {\n \"UserName\": \"xx\",\n \"Zone\": \"xx\",\n \"ResidentIdentityCard\": \"xx\",\n \"TenantId\": \"xx\",\n \"WechatOpenId\": \"xx\",\n \"Email\": \"xx\",\n \"Status\": \"xx\",\n \"Description\": \"xx\",\n \"UserId\": \"xx\",\n \"Job\": \"xx\",\n \"Address\": \"xx\",\n \"Nationality\": \"xx\",\n \"Nickname\": \"xx\",\n \"UserStoreId\": \"xx\",\n \"QqOpenId\": \"xx\",\n \"Name\": \"xx\",\n \"Gender\": \"xx\",\n \"IdentityVerificationMethod\": \"xx\",\n \"AlipayUserId\": \"xx\",\n \"LastSignOn\": \"xx\",\n \"PhoneNumber\": \"xx\",\n \"QqUnionId\": \"xx\",\n \"Locale\": \"xx\",\n \"Primary\": true,\n \"IdentityVerified\": true,\n \"WechatUnionId\": \"xx\"\n }\n ],\n \"Total\": 0,\n \"Pageable\": {\n \"PageNumber\": 0,\n \"PageSize\": 0\n },\n \"RequestId\": \"xx\"\n }\n}",
110
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListUser\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"Pageable\": {\n \"PageSize\": 10,\n \"PageNumber\": 5\n },\n \"Filters\": [\n {\n \"Key\": \"nickname\",\n \"Values\": [\n \"昵称1\"\n ],\n \"Logic\": true\n }\n ],\n \"Original\": true\n}",
111
+ "output": "{\n \"Response\": {\n \"Total\": 100,\n \"Pageable\": {\n \"PageSize\": 10,\n \"PageNumber\": 5\n },\n \"Content\": [\n {\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"UserName\": \"zhangsan\",\n \"PhoneNumber\": \"132****0000\",\n \"Email\": \"132****@qq.com\",\n \"LastSignOn\": 1711002933442,\n \"CreatedDate\": 1718332940956,\n \"Status\": \"NORMAL\",\n \"UserDataSourceEnum\": \"管理员添加\",\n \"Nickname\": \"昵称1\",\n \"Address\": \"北京市海淀区\",\n \"Birthdate\": 1706682491339,\n \"UserGroups\": [\n \"6cd22e51****************f6f7cb81\"\n ],\n \"LastModifiedDate\": 1722420973329,\n \"CustomAttributes\": [\n {\n \"Name\": \"k\",\n \"Value\": \"v\",\n \"Type\": \"STRING\"\n }\n ],\n \"ResidentIdentityCard\": \"123456789012345678\",\n \"QqOpenId\": \"qqopenid\",\n \"QqUnionId\": \"qqunionid\",\n \"WechatOpenId\": \"wechatopenid\",\n \"WechatUnionId\": \"wechatunionid\",\n \"AlipayUserId\": \"alipayuserid\",\n \"WeComUserId\": \"wecomuserid\",\n \"Description\": \"用户1\",\n \"Name\": \"姓名\",\n \"Locale\": \"地理位置\",\n \"Gender\": \"男\",\n \"IdentityVerificationMethod\": \"-\",\n \"IdentityVerified\": true,\n \"Job\": \"员工\",\n \"Nationality\": \"汉族\",\n \"Primary\": true,\n \"Zone\": \"时区\",\n \"AlreadyFirstLogin\": true,\n \"TenantId\": \"tenantId\",\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"Version\": 0,\n \"LockType\": \"-\",\n \"LockTime\": 0,\n \"IndexedAttribute1\": \"value1\",\n \"IndexedAttribute2\": \"value2\",\n \"IndexedAttribute3\": \"value3\",\n \"IndexedAttribute4\": \"value4\",\n \"IndexedAttribute5\": \"value5\"\n }\n ],\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
112
112
  "title": "查询用户列表"
113
113
  }
114
114
  ],
115
115
  "ListUserByProperty": [
116
116
  {
117
117
  "document": "",
118
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListUserByProperty\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"PropertyCode\": \"xx\",\n \"PropertyValue\": \"xx\"\n}",
119
- "output": "{\n \"Response\": {\n \"Users\": [\n {\n \"UserName\": \"xx\",\n \"Zone\": \"xx\",\n \"UserId\": \"xx\",\n \"ResidentIdentityCard\": \"xx\",\n \"TenantId\": \"xx\",\n \"CustomAttributes\": [\n {\n \"Type\": \"xx\",\n \"Name\": \"xx\",\n \"Value\": \"xx\"\n }\n ],\n \"Version\": 0,\n \"WechatOpenId\": \"xx\",\n \"Email\": \"xx\",\n \"Status\": \"xx\",\n \"Description\": \"xx\",\n \"LastModifiedDate\": 0,\n \"AlreadyFirstLogin\": true,\n \"Job\": \"xx\",\n \"Address\": \"xx\",\n \"Nationality\": \"xx\",\n \"Nickname\": \"xx\",\n \"UserStoreId\": \"xx\",\n \"QqOpenId\": \"xx\",\n \"Name\": \"xx\",\n \"UserDataSourceEnum\": \"xx\",\n \"Gender\": \"xx\",\n \"IdentityVerificationMethod\": \"xx\",\n \"AlipayUserId\": \"xx\",\n \"LastSignOn\": 0,\n \"PhoneNumber\": \"xx\",\n \"Birthdate\": 0,\n \"QqUnionId\": \"xx\",\n \"UserGroups\": [\n \"xx\"\n ],\n \"Locale\": \"xx\",\n \"Primary\": true,\n \"IdentityVerified\": true,\n \"CreatedDate\": 0,\n \"LockTime\": 0,\n \"LockType\": \"xx\",\n \"WechatUnionId\": \"xx\"\n }\n ],\n \"RequestId\": \"xx\"\n }\n}",
118
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListUserByProperty\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"PropertyCode\": \"phoneNumber\",\n \"PropertyValue\": \"130****0000\",\n \"Original\": true\n}",
119
+ "output": "{\n \"Response\": {\n \"Users\": [\n {\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"UserName\": \"zhangsan\",\n \"PhoneNumber\": \"132****0000\",\n \"Email\": \"132****@qq.com\",\n \"LastSignOn\": 1711002933442,\n \"CreatedDate\": 1718332940956,\n \"Status\": \"NORMAL\",\n \"UserDataSourceEnum\": \"管理员添加\",\n \"Nickname\": \"昵称1\",\n \"Address\": \"北京市海淀区\",\n \"Birthdate\": 1706682491339,\n \"UserGroups\": [\n \"6cd22e51****************f6f7cb81\"\n ],\n \"LastModifiedDate\": 1722420973329,\n \"CustomAttributes\": [\n {\n \"Name\": \"k\",\n \"Value\": \"v\",\n \"Type\": \"STRING\"\n }\n ],\n \"ResidentIdentityCard\": \"123456789012345678\",\n \"QqOpenId\": \"qqopenid\",\n \"QqUnionId\": \"qqunionid\",\n \"WechatOpenId\": \"wechatopenid\",\n \"WechatUnionId\": \"wechatunionid\",\n \"AlipayUserId\": \"alipayuserid\",\n \"WeComUserId\": \"wecomuserid\",\n \"Description\": \"用户1\",\n \"Name\": \"姓名\",\n \"Locale\": \"地理位置\",\n \"Gender\": \"男\",\n \"IdentityVerificationMethod\": \"-\",\n \"IdentityVerified\": true,\n \"Job\": \"员工\",\n \"Nationality\": \"汉族\",\n \"Primary\": true,\n \"Zone\": \"时区\",\n \"AlreadyFirstLogin\": true,\n \"TenantId\": \"tenantId\",\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"Version\": 0,\n \"LockType\": \"-\",\n \"LockTime\": 0,\n \"IndexedAttribute1\": \"value1\",\n \"IndexedAttribute2\": \"value2\",\n \"IndexedAttribute3\": \"value3\",\n \"IndexedAttribute4\": \"value4\",\n \"IndexedAttribute5\": \"value5\"\n }\n ],\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
120
120
  "title": "查询用户列表"
121
121
  }
122
122
  ],
123
123
  "ListUserGroups": [
124
124
  {
125
125
  "document": "",
126
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListUserGroups\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"Pageable\": {\n \"PageNumber\": 0,\n \"PageSize\": 0\n },\n \"Filters\": [\n {\n \"Values\": [\n \"xx\"\n ],\n \"Key\": \"xx\",\n \"Logic\": true\n }\n ]\n}",
127
- "output": "{\n \"Response\": {\n \"Content\": [\n {\n \"UserStoreId\": \"xx\",\n \"DisplayName\": \"xx\",\n \"Description\": \"xx\",\n \"UserGroupId\": \"xx\",\n \"TenantId\": \"xx\"\n }\n ],\n \"Total\": 0,\n \"Pageable\": {\n \"PageNumber\": 0,\n \"PageSize\": 0\n },\n \"RequestId\": \"xx\"\n }\n}",
126
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListUserGroups\n<公共请求参数>\n\n{\n \"UserStoreId\": \"6cd22e51****************f6f7cb81\",\n \"Pageable\": {\n \"PageSize\": 10,\n \"PageNumber\": 5\n },\n \"Filters\": [\n {\n \"Key\": \"condition\",\n \"Values\": [\n \"1\"\n ],\n \"Logic\": true\n }\n ]\n}",
127
+ "output": "{\n \"Response\": {\n \"Content\": [\n {\n \"UserGroupId\": \"6cd22e51****************f6f7cb81\",\n \"DisplayName\": \"用户组1\",\n \"Description\": \"包含了一组用户\",\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"TenantId\": \"tenantId\",\n \"CreatedDate\": 1651073285427,\n \"LastModifyDate\": 1651073285306\n }\n ],\n \"Total\": 100,\n \"Pageable\": {\n \"PageSize\": 10,\n \"PageNumber\": 5\n },\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
128
128
  "title": "查询用户组列表"
129
129
  }
130
130
  ],
@@ -132,55 +132,55 @@
132
132
  {
133
133
  "document": "",
134
134
  "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListUserStore\n<公共请求参数>\n\n{}",
135
- "output": "{\n \"Response\": {\n \"UserStoreSet\": [\n {\n \"UserStoreName\": \"xx\",\n \"UserStoreId\": \"xx\",\n \"UserStoreDesc\": \"xx\",\n \"UserNum\": 0,\n \"TenantId\": \"xx\",\n \"AppNum\": 0,\n \"UserStoreLogo\": \"xx\",\n \"LastStatus\": false,\n \"DefaultStatus\": false,\n \"CreateDate\": 1630328714604,\n \"LastStatusTime\": 1630328714604\n }\n ],\n \"RequestId\": \"xx\"\n }\n}",
135
+ "output": "{\n \"Response\": {\n \"UserStoreSet\": [\n {\n \"TenantId\": \"tenantId\",\n \"UserStoreLogo\": \"https://aa.com/bb.png\",\n \"UserStoreDesc\": \"管理应用和用户\",\n \"UserStoreName\": \"目录1\",\n \"UserNum\": 10,\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"AppNum\": 0,\n \"LastStatus\": true,\n \"DefaultStatus\": true,\n \"CreateDate\": 1706682491339,\n \"LastStatusTime\": 1713168583556,\n \"UserStoreProtocolHost\": \"leecpn\"\n }\n ],\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
136
136
  "title": "查询用户目录列表"
137
137
  }
138
138
  ],
139
139
  "ResetPassword": [
140
140
  {
141
141
  "document": "",
142
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResetPassword\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"UserId\": \"xx\"\n}",
143
- "output": "{\n \"Response\": {\n \"Password\": \"xx\",\n \"RequestId\": \"xx\"\n }\n}",
142
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResetPassword\n<公共请求参数>\n\n{\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\"\n}",
143
+ "output": "{\n \"Response\": {\n \"Password\": \"password\",\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
144
144
  "title": "重置用户密码"
145
145
  }
146
146
  ],
147
147
  "SetPassword": [
148
148
  {
149
149
  "document": "",
150
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetPassword\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xx\",\n \"Password\": \"xx\",\n \"UserId\": \"xx\"\n}",
151
- "output": "{\n \"Response\": {\n \"RequestId\": \"xx\"\n }\n}",
150
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetPassword\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"Password\": \"password\"\n}",
151
+ "output": "{\n \"Response\": {\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
152
152
  "title": "设置用户密码"
153
153
  }
154
154
  ],
155
155
  "UpdateUser": [
156
156
  {
157
- "document": "",
158
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateUser\n<公共请求参数>\n\n{\n \"UserName\": \"xx\",\n \"UserStoreId\": \"xx\",\n \"UserGroup\": [\n \"xxx\"\n ],\n \"UserId\": \"xx\",\n \"Birthdate\": 0,\n \"PhoneNumber\": \"xx\",\n \"Address\": \"xx\",\n \"Nickname\": \"xx\",\n \"Email\": \"xx\",\n \"CustomizationAttributes\": [\n {\n \"Name\": \"xx\",\n \"Value\": \"xx\",\n \"Type\": \"xx\"\n }\n ]\n}",
159
- "output": "{\n \"Response\": {\n \"RequestId\": \"xxx\",\n \"User\": null\n }\n}",
157
+ "document": "更新用户信息时使用",
158
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateUser\n<公共请求参数>\n\n{\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"UserName\": \"zhangsan\",\n \"PhoneNumber\": \"132****0000\",\n \"Email\": \"132****@qq.com\",\n \"Nickname\": \"昵称1\",\n \"Address\": \"北京市海淀区\",\n \"UserGroup\": [\n \"6cd22e51****************f6f7cb81\"\n ],\n \"Birthdate\": 1706682491339,\n \"CustomizationAttributes\": [\n {\n \"Name\": \"k\",\n \"Value\": \"v\",\n \"Type\": \"STRING\"\n }\n ],\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"IndexedAttribute1\": \"value1\",\n \"IndexedAttribute2\": \"value2\",\n \"IndexedAttribute3\": \"value3\",\n \"IndexedAttribute4\": \"value4\",\n \"IndexedAttribute5\": \"value5\"\n}",
159
+ "output": "{\n \"Response\": {\n \"User\": {\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"UserName\": \"zhangsan\",\n \"PhoneNumber\": \"132****0000\",\n \"Email\": \"132****@qq.com\",\n \"LastSignOn\": 1711002933442,\n \"CreatedDate\": 1718332940956,\n \"Status\": \"NORMAL\",\n \"UserDataSourceEnum\": \"管理员添加\",\n \"Nickname\": \"昵称1\",\n \"Address\": \"北京市海淀区\",\n \"Birthdate\": 1706682491339,\n \"UserGroups\": [\n \"6cd22e51****************f6f7cb81\"\n ],\n \"LastModifiedDate\": 1722420973329,\n \"CustomAttributes\": [\n {\n \"Name\": \"k\",\n \"Value\": \"v\",\n \"Type\": \"STRING\"\n }\n ],\n \"ResidentIdentityCard\": \"123456789012345678\",\n \"QqOpenId\": \"qqopenid\",\n \"QqUnionId\": \"qqunionid\",\n \"WechatOpenId\": \"wechatopenid\",\n \"WechatUnionId\": \"wechatunionid\",\n \"AlipayUserId\": \"alipayuserid\",\n \"WeComUserId\": \"wecomuserid\",\n \"Description\": \"用户1\",\n \"Name\": \"姓名\",\n \"Locale\": \"地理位置\",\n \"Gender\": \"男\",\n \"IdentityVerificationMethod\": \"-\",\n \"IdentityVerified\": true,\n \"Job\": \"员工\",\n \"Nationality\": \"汉族\",\n \"Primary\": true,\n \"Zone\": \"时区\",\n \"AlreadyFirstLogin\": true,\n \"TenantId\": \"tenantId\",\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"Version\": 0,\n \"LockType\": \"-\",\n \"LockTime\": 0,\n \"IndexedAttribute1\": \"value1\",\n \"IndexedAttribute2\": \"value2\",\n \"IndexedAttribute3\": \"value3\",\n \"IndexedAttribute4\": \"value4\",\n \"IndexedAttribute5\": \"value5\"\n },\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
160
160
  "title": "更新用户"
161
161
  }
162
162
  ],
163
163
  "UpdateUserGroup": [
164
164
  {
165
165
  "document": "",
166
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateUserGroup\n<公共请求参数>\n\n{\n \"UserStoreId\": \"xxx\",\n \"UserGroupId\": \"xxx\",\n \"DisplayName\": \"xxx\",\n \"Description\": \"xxx\"\n}",
167
- "output": "{\n \"Response\": {\n \"RequestId\": \"xxx\"\n }\n}",
166
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateUserGroup\n<公共请求参数>\n\n{\n \"UserGroupId\": \"6cd22e51****************f6f7cb81\",\n \"DisplayName\": \"用户组1\",\n \"Description\": \"包含了一组用户\",\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\"\n}",
167
+ "output": "{\n \"Response\": {\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
168
168
  "title": "更新用户组"
169
169
  }
170
170
  ],
171
171
  "UpdateUserStatus": [
172
172
  {
173
173
  "document": "",
174
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateUserStatus\n<公共请求参数>\n\n{\n \"UserId\": \"xxx\",\n \"Status\": \"xxx\",\n \"UserStoreId\": \"xxx\"\n}",
175
- "output": "{\n \"Response\": {\n \"RequestId\": \"xx\"\n }\n}",
174
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateUserStatus\n<公共请求参数>\n\n{\n \"UserStoreId\": \"2c3aca3b****************a7efe88e\",\n \"UserId\": \"53e25c3****************e4eb5bd1\",\n \"Status\": \"NORMAL\"\n}",
175
+ "output": "{\n \"Response\": {\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
176
176
  "title": "更新用户状态"
177
177
  }
178
178
  ],
179
179
  "UpdateUserStore": [
180
180
  {
181
181
  "document": "",
182
- "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateUserStore\n<公共请求参数>\n\n{\n \"UserPoolDesc\": \"xx\",\n \"UserPoolName\": \"xx\",\n \"UserPoolLogo\": \"xx\",\n \"UserPoolId\": \"xx\"\n}",
183
- "output": "{\n \"Response\": {\n \"RequestId\": \"xx\"\n }\n}",
182
+ "input": "POST / HTTP/1.1\nHost: ciam.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: UpdateUserStore\n<公共请求参数>\n\n{\n \"UserPoolId\": \"2c3aca3b****************a7efe88e\",\n \"UserPoolName\": \"目录1\",\n \"UserPoolDesc\": \"管理应用和用户\",\n \"UserPoolLogo\": \"https://**.com/***b.png\"\n}",
183
+ "output": "{\n \"Response\": {\n \"RequestId\": \"e2e9e8aa********************9ab34c6e\"\n }\n}",
184
184
  "title": "更新用户目录"
185
185
  }
186
186
  ]
@@ -4604,7 +4604,7 @@
4604
4604
  },
4605
4605
  {
4606
4606
  "disabled": false,
4607
- "document": "主题消息最大值,单位为 Byte,最小值1024Byte(即1KB),最大值为8388608Byte(即8MB)。",
4607
+ "document": "主题消息最大值,单位为 Byte,最小值1024Byte(即1KB),最大值为12582912Byte(即12MB)",
4608
4608
  "example": "1024",
4609
4609
  "member": "int64",
4610
4610
  "name": "MaxMessageBytes",