tccli 3.0.1042.1__py2.py3-none-any.whl → 3.0.1043.1__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.
@@ -1,95 +1,67 @@
1
1
  {
2
2
  "actions": {
3
- "CheckChain": {
4
- "document": "该接口不再使用\n\n检查区块链信息",
5
- "input": "CheckChainRequest",
6
- "name": "检查区块链信息",
7
- "output": "CheckChainResponse",
8
- "status": "deprecated"
9
- },
10
- "CreateCredential": {
11
- "document": "该接口不再使用\n\n创建凭证",
12
- "input": "CreateCredentialRequest",
13
- "name": "创建凭证",
14
- "output": "CreateCredentialResponse",
15
- "status": "deprecated"
16
- },
17
- "CreateSelectiveCredential": {
18
- "document": "该接口不再使用\n\n创建选择性批露凭证",
19
- "input": "CreateSelectiveCredentialRequest",
20
- "name": "创建选择性批露凭证",
21
- "output": "CreateSelectiveCredentialResponse",
22
- "status": "deprecated"
23
- },
24
- "CreateTDid": {
25
- "document": "该接口不再使用\n\n创建机构DID",
26
- "input": "CreateTDidRequest",
27
- "name": "创建机构DID",
28
- "output": "CreateTDidResponse",
29
- "status": "deprecated"
30
- },
31
- "CreateTDidByPrivateKey": {
32
- "document": "该接口不再使用\n\n新建DID根据私钥生成Tdid",
33
- "input": "CreateTDidByPrivateKeyRequest",
34
- "name": "新建DID根据私钥生成Tdid",
35
- "output": "CreateTDidByPrivateKeyResponse",
36
- "status": "deprecated"
37
- },
38
- "CreateTDidByPublicKey": {
39
- "document": "该接口不再使用\n\n 新建DID根据公钥生成Tdid",
40
- "input": "CreateTDidByPublicKeyRequest",
41
- "name": "新建DID根据公钥生成Tdid",
42
- "output": "CreateTDidByPublicKeyResponse",
43
- "status": "deprecated"
44
- },
45
- "GetAuthorityIssuer": {
46
- "document": "该接口不再使用\n\n获取权威机构信息",
47
- "input": "GetAuthorityIssuerRequest",
48
- "name": "获取权威机构信息",
49
- "output": "GetAuthorityIssuerResponse",
50
- "status": "deprecated"
51
- },
52
- "GetCptInfo": {
53
- "document": "该接口不再使用\n\n凭证模版详情",
54
- "input": "GetCptInfoRequest",
55
- "name": "凭证模版详情",
56
- "output": "GetCptInfoResponse",
57
- "status": "deprecated"
58
- },
59
- "GetCredentialStatus": {
60
- "document": "该接口不再使用\n\n获取凭证链上状态信息",
61
- "input": "GetCredentialStatusRequest",
62
- "name": "获取凭证链上状态",
63
- "output": "GetCredentialStatusResponse",
64
- "status": "deprecated"
65
- },
66
- "GetDidDocument": {
67
- "document": "该接口不再使用\n\n查看DID文档\n",
68
- "input": "GetDidDocumentRequest",
69
- "name": "查看DID文档",
70
- "output": "GetDidDocumentResponse",
71
- "status": "deprecated"
72
- },
73
- "RegisterCpt": {
74
- "document": "该接口不再使用\n\n凭证模版新建",
75
- "input": "RegisterCptRequest",
76
- "name": "凭证模版新建",
77
- "output": "RegisterCptResponse",
78
- "status": "deprecated"
79
- },
80
- "SetCredentialStatus": {
81
- "document": "该接口不再使用\n\n设置凭证链上状态",
82
- "input": "SetCredentialStatusRequest",
83
- "name": "设置凭证链上状态",
84
- "output": "SetCredentialStatusResponse",
85
- "status": "deprecated"
86
- },
87
- "VerifyCredential": {
88
- "document": "该接口不再使用\n\n验证凭证",
89
- "input": "VerifyCredentialRequest",
90
- "name": "验证凭证",
91
- "output": "VerifyCredentialResponse",
92
- "status": "deprecated"
3
+ "CheckNewPurchase": {
4
+ "document": "检查用户套餐购买状态",
5
+ "input": "CheckNewPurchaseRequest",
6
+ "name": "检查用户套餐购买状态",
7
+ "output": "CheckNewPurchaseResponse",
8
+ "status": "online"
9
+ },
10
+ "CreateTDidByHost": {
11
+ "document": "自动生成公私钥对托管在DID平台,并注册DID标识",
12
+ "input": "CreateTDidByHostRequest",
13
+ "name": "自动生成公私钥注册DID标识",
14
+ "output": "CreateTDidByHostResponse",
15
+ "status": "online"
16
+ },
17
+ "CreateTDidByPubKey": {
18
+ "document": "使用导入的公钥文件注册DID标识",
19
+ "input": "CreateTDidByPubKeyRequest",
20
+ "name": "导入公钥注册DID标识",
21
+ "output": "CreateTDidByPubKeyResponse",
22
+ "status": "online"
23
+ },
24
+ "DeactivateTDid": {
25
+ "document": "更新DID标识的禁用状态",
26
+ "input": "DeactivateTDidRequest",
27
+ "name": "更新DID标识的禁用状态",
28
+ "output": "DeactivateTDidResponse",
29
+ "status": "online"
30
+ },
31
+ "GetCredentialState": {
32
+ "document": "获取凭证链上状态信息",
33
+ "input": "GetCredentialStateRequest",
34
+ "name": "获取凭证链上的状态",
35
+ "output": "GetCredentialStateResponse",
36
+ "status": "online"
37
+ },
38
+ "GetTDidDocument": {
39
+ "document": "获取DID标识的文档",
40
+ "input": "GetTDidDocumentRequest",
41
+ "name": "获取DID标识的文档",
42
+ "output": "GetTDidDocumentResponse",
43
+ "status": "online"
44
+ },
45
+ "IssueCredential": {
46
+ "document": "颁发可验证凭证",
47
+ "input": "IssueCredentialRequest",
48
+ "name": "颁发可验证凭证",
49
+ "output": "IssueCredentialResponse",
50
+ "status": "online"
51
+ },
52
+ "UpdateCredentialState": {
53
+ "document": "更新凭证的链上状态",
54
+ "input": "UpdateCredentialStateRequest",
55
+ "name": "更新凭证的链上状态",
56
+ "output": "UpdateCredentialStateResponse",
57
+ "status": "online"
58
+ },
59
+ "VerifyCredentials": {
60
+ "document": "验证已签名的可验证凭证",
61
+ "input": "VerifyCredentialsRequest",
62
+ "name": "验证可验证凭证",
63
+ "output": "VerifyCredentialsResponse",
64
+ "status": "online"
93
65
  }
94
66
  },
95
67
  "metadata": {
@@ -99,182 +71,96 @@
99
71
  "serviceShortName": "tdid"
100
72
  },
101
73
  "objects": {
102
- "CheckChainRequest": {
103
- "document": "CheckChain请求参数结构体",
104
- "members": [
105
- {
106
- "disabled": false,
107
- "document": "群组ID",
108
- "example": "1",
109
- "member": "int64",
110
- "name": "GroupId",
111
- "required": true,
112
- "type": "int"
113
- },
114
- {
115
- "disabled": false,
116
- "document": "网络ID",
117
- "example": "bcos-fmtkyt8xne",
118
- "member": "string",
119
- "name": "ClusterId",
120
- "required": true,
121
- "type": "string"
122
- },
123
- {
124
- "disabled": false,
125
- "document": "did服务机构名称",
126
- "example": "test",
127
- "member": "string",
128
- "name": "AgencyName",
129
- "required": true,
130
- "type": "string"
131
- }
132
- ],
133
- "type": "object"
134
- },
135
- "CheckChainResponse": {
136
- "document": "CheckChain返回参数结构体",
74
+ "CRDLArg": {
75
+ "document": "颁发凭证的数据参数",
137
76
  "members": [
138
77
  {
139
78
  "disabled": false,
140
- "document": "1为盟主,0为非盟主",
79
+ "document": "CPT ID",
141
80
  "example": "1",
142
- "member": "int64",
143
- "name": "RoleType",
81
+ "member": "uint64",
82
+ "name": "CPTId",
144
83
  "required": true,
145
84
  "type": "int",
146
85
  "value_allowed_null": false
147
86
  },
148
87
  {
149
88
  "disabled": false,
150
- "document": "链ID",
151
- "example": "bcos-fmtkyt8xne",
89
+ "document": "签发者 did",
90
+ "example": "1",
152
91
  "member": "string",
153
- "name": "ChainId",
92
+ "name": "Issuer",
154
93
  "required": true,
155
94
  "type": "string",
156
95
  "value_allowed_null": false
157
96
  },
158
97
  {
159
98
  "disabled": false,
160
- "document": "应用名称",
161
- "example": "test",
99
+ "document": "过期时间",
100
+ "example": "1",
162
101
  "member": "string",
163
- "name": "AppName",
102
+ "name": "ExpirationDate",
164
103
  "required": true,
165
104
  "type": "string",
166
105
  "value_allowed_null": false
167
106
  },
168
- {
169
- "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
170
- "member": "string",
171
- "name": "RequestId",
172
- "type": "string"
173
- }
174
- ],
175
- "type": "object"
176
- },
177
- "CreateCredentialRequest": {
178
- "document": "CreateCredential请求参数结构体",
179
- "members": [
180
- {
181
- "disabled": false,
182
- "document": "参数集合,详见示例",
183
- "example": "无",
184
- "member": "FunctionArg",
185
- "name": "FunctionArg",
186
- "required": true,
187
- "type": "object"
188
- },
189
107
  {
190
108
  "disabled": false,
191
- "document": "参数集合,详见示例",
192
- "example": "",
193
- "member": "TransactionArg",
194
- "name": "TransactionArg",
109
+ "document": "声明",
110
+ "example": "1",
111
+ "member": "string",
112
+ "name": "ClaimJson",
195
113
  "required": true,
196
- "type": "object"
114
+ "type": "string",
115
+ "value_allowed_null": false
197
116
  },
198
117
  {
199
118
  "disabled": false,
200
- "document": "版本",
201
- "example": "1.0.0",
119
+ "document": "凭证类型",
120
+ "example": "[\"TempCredential\"]",
202
121
  "member": "string",
203
- "name": "VersionCredential",
204
- "required": true,
205
- "type": "string"
122
+ "name": "Type",
123
+ "required": false,
124
+ "type": "list",
125
+ "value_allowed_null": false
206
126
  },
207
127
  {
208
128
  "disabled": false,
209
- "document": "是否未签名",
210
- "example": "true",
211
- "member": "bool",
212
- "name": "UnSigned",
129
+ "document": "多方签名的用户did",
130
+ "example": "[]",
131
+ "member": "string",
132
+ "name": "Parties",
213
133
  "required": false,
214
- "type": "bool"
134
+ "type": "list",
135
+ "value_allowed_null": false
215
136
  }
216
137
  ],
217
- "type": "object"
138
+ "usage": "in"
218
139
  },
219
- "CreateCredentialResponse": {
220
- "document": "CreateCredential返回参数结构体",
140
+ "ChainTransaction": {
141
+ "document": "链上交易信息",
221
142
  "members": [
222
143
  {
223
144
  "disabled": false,
224
- "document": "Credential的具体信息",
225
- "example": "c",
145
+ "document": "交易哈希",
146
+ "example": "1705db1b691f30dccabd753fa5aece73badb8c079b7d4861816d7e14b3b7d430",
226
147
  "member": "string",
227
- "name": "CredentialData",
148
+ "name": "TransactionHash",
228
149
  "required": true,
229
150
  "type": "string",
230
151
  "value_allowed_null": false
231
- },
232
- {
233
- "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
234
- "member": "string",
235
- "name": "RequestId",
236
- "type": "string"
237
152
  }
238
153
  ],
239
- "type": "object"
154
+ "usage": "out"
240
155
  },
241
- "CreateSelectiveCredentialRequest": {
242
- "document": "CreateSelectiveCredential请求参数结构体",
243
- "members": [
244
- {
245
- "disabled": false,
246
- "document": "参数集合",
247
- "example": "1",
248
- "member": "VerifyFunctionArg",
249
- "name": "FunctionArg",
250
- "required": true,
251
- "type": "object"
252
- },
253
- {
254
- "disabled": false,
255
- "document": "批露策略id",
256
- "example": "2000000",
257
- "member": "uint64",
258
- "name": "PolicyId",
259
- "required": true,
260
- "type": "int"
261
- }
262
- ],
156
+ "CheckNewPurchaseRequest": {
157
+ "document": "CheckNewPurchase请求参数结构体",
158
+ "members": [],
263
159
  "type": "object"
264
160
  },
265
- "CreateSelectiveCredentialResponse": {
266
- "document": "CreateSelectiveCredential返回参数结构体",
161
+ "CheckNewPurchaseResponse": {
162
+ "document": "CheckNewPurchase返回参数结构体",
267
163
  "members": [
268
- {
269
- "disabled": false,
270
- "document": "凭证字符串",
271
- "example": "{}",
272
- "member": "string",
273
- "name": "CredentialData",
274
- "required": true,
275
- "type": "string",
276
- "value_allowed_null": false
277
- },
278
164
  {
279
165
  "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
280
166
  "member": "string",
@@ -284,52 +170,53 @@
284
170
  ],
285
171
  "type": "object"
286
172
  },
287
- "CreateTDidByPrivateKeyRequest": {
288
- "document": "CreateTDidByPrivateKey请求参数结构体",
173
+ "CreateTDidByHostRequest": {
174
+ "document": "CreateTDidByHost请求参数结构体",
289
175
  "members": [
290
176
  {
291
177
  "disabled": false,
292
- "document": "网络ID",
293
- "example": "bcos-fmtkyt8xne",
294
- "member": "string",
295
- "name": "ClusterId",
296
- "required": true,
297
- "type": "string"
298
- },
299
- {
300
- "disabled": false,
301
- "document": "群组ID",
178
+ "document": "DID应用ID",
302
179
  "example": "1",
303
180
  "member": "uint64",
304
- "name": "GroupId",
305
- "required": true,
181
+ "name": "DAPId",
182
+ "required": false,
306
183
  "type": "int"
307
184
  },
308
185
  {
309
186
  "disabled": false,
310
- "document": "私钥",
311
- "example": "test",
187
+ "document": "自定义DID文档json属性",
188
+ "example": "{}",
312
189
  "member": "string",
313
- "name": "PrivateKey",
314
- "required": true,
190
+ "name": "CustomAttribute",
191
+ "required": false,
315
192
  "type": "string"
316
193
  }
317
194
  ],
318
195
  "type": "object"
319
196
  },
320
- "CreateTDidByPrivateKeyResponse": {
321
- "document": "CreateTDidByPrivateKey返回参数结构体",
197
+ "CreateTDidByHostResponse": {
198
+ "document": "CreateTDidByHost返回参数结构体",
322
199
  "members": [
323
200
  {
324
201
  "disabled": false,
325
- "document": "did的具体信息",
326
- "example": "did:tdid:1:0x6dcc17846844ff22046a3cc5ae51941defe0d02c",
202
+ "document": "DID标识",
203
+ "example": "did:tdid:w1:0xdab41eb32082044366f1b5712504d0b623b095c1",
327
204
  "member": "string",
328
205
  "name": "Did",
329
- "required": true,
206
+ "output_required": true,
330
207
  "type": "string",
331
208
  "value_allowed_null": false
332
209
  },
210
+ {
211
+ "disabled": false,
212
+ "document": "链上交易信息",
213
+ "example": "无",
214
+ "member": "ChainTransaction",
215
+ "name": "Transaction",
216
+ "output_required": true,
217
+ "type": "object",
218
+ "value_allowed_null": false
219
+ },
333
220
  {
334
221
  "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
335
222
  "member": "string",
@@ -339,116 +226,71 @@
339
226
  ],
340
227
  "type": "object"
341
228
  },
342
- "CreateTDidByPublicKeyRequest": {
343
- "document": "CreateTDidByPublicKey请求参数结构体",
229
+ "CreateTDidByPubKeyRequest": {
230
+ "document": "CreateTDidByPubKey请求参数结构体",
344
231
  "members": [
345
232
  {
346
233
  "disabled": false,
347
- "document": "网络ID",
348
- "example": "bcos-fmtkyt8xne",
349
- "member": "string",
350
- "name": "ClusterId",
351
- "required": true,
352
- "type": "string"
353
- },
354
- {
355
- "disabled": false,
356
- "document": "群组ID",
234
+ "document": "DID应用id",
357
235
  "example": "1",
358
236
  "member": "uint64",
359
- "name": "GroupId",
360
- "required": true,
237
+ "name": "DAPId",
238
+ "required": false,
361
239
  "type": "int"
362
240
  },
363
241
  {
364
242
  "disabled": false,
365
- "document": "身份公钥",
366
- "example": "test1",
243
+ "document": "pem格式的认证公钥",
244
+ "example": "test",
367
245
  "member": "string",
368
246
  "name": "PublicKey",
369
- "required": true,
247
+ "required": false,
370
248
  "type": "string"
371
249
  },
372
250
  {
373
251
  "disabled": false,
374
- "document": "加密公钥",
375
- "example": "test",
252
+ "document": "自定义DID初始化属性json字符串",
253
+ "example": "{}",
376
254
  "member": "string",
377
- "name": "EncryptPubKey",
255
+ "name": "CustomAttribute",
378
256
  "required": false,
379
257
  "type": "string"
380
- }
381
- ],
382
- "type": "object"
383
- },
384
- "CreateTDidByPublicKeyResponse": {
385
- "document": "CreateTDidByPublicKey返回参数结构体",
386
- "members": [
387
- {
388
- "disabled": false,
389
- "document": "did具体信息",
390
- "example": "did:tdid:1:0x4b5edc27dd8a20ebaae6d427f3142b24fbf687ff",
391
- "member": "string",
392
- "name": "Did",
393
- "required": true,
394
- "type": "string",
395
- "value_allowed_null": false
396
258
  },
397
- {
398
- "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
399
- "member": "string",
400
- "name": "RequestId",
401
- "type": "string"
402
- }
403
- ],
404
- "type": "object"
405
- },
406
- "CreateTDidRequest": {
407
- "document": "CreateTDid请求参数结构体",
408
- "members": [
409
259
  {
410
260
  "disabled": false,
411
- "document": "群组ID",
261
+ "document": "0:did存在返回错误,1:did存在返回该did,默认:0",
412
262
  "example": "1",
413
263
  "member": "uint64",
414
- "name": "GroupId",
415
- "required": true,
416
- "type": "int"
417
- },
418
- {
419
- "disabled": false,
420
- "document": "网络ID",
421
- "example": "bcos-fmtkyt8xne",
422
- "member": "string",
423
- "name": "ClusterId",
424
- "required": true,
425
- "type": "string"
426
- },
427
- {
428
- "disabled": false,
429
- "document": "部署机构为1,否则为0",
430
- "example": "0",
431
- "member": "uint64",
432
- "name": "Relegation",
433
- "required": true,
264
+ "name": "IgnoreExisted",
265
+ "required": false,
434
266
  "type": "int"
435
267
  }
436
268
  ],
437
269
  "type": "object"
438
270
  },
439
- "CreateTDidResponse": {
440
- "document": "CreateTDid返回参数结构体",
271
+ "CreateTDidByPubKeyResponse": {
272
+ "document": "CreateTDidByPubKey返回参数结构体",
441
273
  "members": [
442
274
  {
443
275
  "disabled": false,
444
- "document": "TDID",
445
- "example": "did:tdid:1:0xdab41eb32082044366f1b5712504d0b623b095c1",
276
+ "document": "did标识",
277
+ "example": "did:tdid:w1:0x4b5edc27dd8a20ebaae6d427f3142b24fbf687ff",
446
278
  "member": "string",
447
279
  "name": "Did",
448
- "required": true,
280
+ "output_required": true,
449
281
  "type": "string",
450
282
  "value_allowed_null": false
451
283
  },
284
+ {
285
+ "disabled": false,
286
+ "document": "链上交易信息",
287
+ "example": "无",
288
+ "member": "ChainTransaction",
289
+ "name": "Transaction",
290
+ "output_required": true,
291
+ "type": "object",
292
+ "value_allowed_null": false
293
+ },
452
294
  {
453
295
  "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
454
296
  "member": "string",
@@ -458,7 +300,7 @@
458
300
  ],
459
301
  "type": "object"
460
302
  },
461
- "CredentialStatus": {
303
+ "CredentialState": {
462
304
  "document": "凭证链上状态信息",
463
305
  "members": [
464
306
  {
@@ -466,8 +308,9 @@
466
308
  "document": "凭证唯一id",
467
309
  "example": "a",
468
310
  "member": "string",
469
- "name": "CredentialId",
470
- "required": true,
311
+ "name": "Id",
312
+ "output_required": false,
313
+ "required": false,
471
314
  "type": "string",
472
315
  "value_allowed_null": false
473
316
  },
@@ -477,222 +320,155 @@
477
320
  "example": "1",
478
321
  "member": "uint64",
479
322
  "name": "Status",
480
- "required": true,
323
+ "output_required": false,
324
+ "required": false,
481
325
  "type": "int",
482
326
  "value_allowed_null": false
483
327
  },
484
328
  {
485
329
  "disabled": false,
486
330
  "document": "凭证颁发者Did",
487
- "example": "a",
331
+ "example": "did:tdid:c859:0x833e89118443c623a8ab063d9ef08268268fe3a4",
488
332
  "member": "string",
489
333
  "name": "Issuer",
490
- "required": true,
334
+ "output_required": false,
335
+ "required": false,
491
336
  "type": "string",
492
337
  "value_allowed_null": false
493
338
  },
494
339
  {
495
340
  "disabled": false,
496
- "document": "凭证摘要\n注意:此字段可能返回 null,表示取不到有效值。",
341
+ "document": "VC摘要,对应凭证Proof的vcDigest字段",
497
342
  "example": "a",
498
343
  "member": "string",
499
- "name": "Digest",
500
- "required": true,
344
+ "name": "VCDigest",
345
+ "output_required": false,
346
+ "required": false,
501
347
  "type": "string",
502
- "value_allowed_null": true
348
+ "value_allowed_null": false
503
349
  },
504
350
  {
505
351
  "disabled": false,
506
- "document": "凭证签名\n注意:此字段可能返回 null,表示取不到有效值。",
352
+ "document": "交易摘要,对应凭证Proof的txDigest字段 ",
507
353
  "example": "a",
508
354
  "member": "string",
509
- "name": "Signature",
510
- "required": true,
355
+ "name": "TXDigest",
356
+ "output_required": false,
357
+ "required": false,
511
358
  "type": "string",
512
- "value_allowed_null": true
359
+ "value_allowed_null": false
513
360
  },
514
361
  {
515
362
  "disabled": false,
516
- "document": "更新时间戳\n注意:此字段可能返回 null,表示取不到有效值。",
363
+ "document": "颁布凭证的UTC时间戳",
517
364
  "example": "1",
518
365
  "member": "uint64",
519
- "name": "TimeStamp",
520
- "required": true,
366
+ "name": "IssueTime",
367
+ "output_required": false,
368
+ "required": false,
521
369
  "type": "int",
522
- "value_allowed_null": true
523
- }
524
- ],
525
- "usage": "both"
526
- },
527
- "FunctionArg": {
528
- "document": "创建凭证入参的FunctionArg",
529
- "members": [
370
+ "value_allowed_null": false
371
+ },
530
372
  {
531
373
  "disabled": false,
532
- "document": "CPT ID",
533
- "example": "1",
374
+ "document": "凭证过期的UTC时间戳",
375
+ "example": "",
534
376
  "member": "uint64",
535
- "name": "CptId",
536
- "required": true,
377
+ "name": "ExpireTime",
378
+ "output_required": false,
379
+ "required": false,
537
380
  "type": "int",
538
381
  "value_allowed_null": false
539
382
  },
540
383
  {
541
384
  "disabled": false,
542
- "document": "签发者 did",
543
- "example": "1",
544
- "member": "string",
545
- "name": "Issuer",
546
- "required": true,
547
- "type": "string",
385
+ "document": "凭证模板id",
386
+ "example": "",
387
+ "member": "uint64",
388
+ "name": "CPTId",
389
+ "output_required": false,
390
+ "required": false,
391
+ "type": "int",
548
392
  "value_allowed_null": false
549
393
  },
550
394
  {
551
395
  "disabled": false,
552
- "document": "过期时间",
553
- "example": "1",
396
+ "document": "凭证签名",
397
+ "example": "",
554
398
  "member": "string",
555
- "name": "ExpirationDate",
556
- "required": true,
399
+ "name": "Signature",
400
+ "output_required": false,
401
+ "required": false,
557
402
  "type": "string",
558
403
  "value_allowed_null": false
559
404
  },
560
405
  {
561
406
  "disabled": false,
562
- "document": "声明",
563
- "example": "1",
407
+ "document": "元数据摘要",
408
+ "example": "",
564
409
  "member": "string",
565
- "name": "ClaimJson",
566
- "required": true,
410
+ "name": "MetaDigest",
411
+ "output_required": false,
412
+ "required": false,
567
413
  "type": "string",
568
414
  "value_allowed_null": false
569
415
  }
570
416
  ],
571
- "usage": "in"
417
+ "usage": "both"
572
418
  },
573
- "GetAuthorityIssuerRequest": {
574
- "document": "GetAuthorityIssuer请求参数结构体",
419
+ "DeactivateTDidRequest": {
420
+ "document": "DeactivateTDid请求参数结构体",
575
421
  "members": [
576
422
  {
577
423
  "disabled": false,
578
- "document": "tdid",
579
- "example": "did:tdid:1:0xa75368ab6ab9cb6d01e81d22155279ee4eca3f4d",
424
+ "document": "DID标识符",
425
+ "example": "did:tdid:w1:0x05cdde231b90dbcb1e0a9e7a616bf17c7168c2ac",
580
426
  "member": "string",
581
427
  "name": "Did",
582
- "required": true,
428
+ "required": false,
583
429
  "type": "string"
584
- }
585
- ],
586
- "type": "object"
587
- },
588
- "GetAuthorityIssuerResponse": {
589
- "document": "GetAuthorityIssuer返回参数结构体",
590
- "members": [
591
- {
592
- "disabled": false,
593
- "document": "名称",
594
- "example": "test",
595
- "member": "string",
596
- "name": "Name",
597
- "required": true,
598
- "type": "string",
599
- "value_allowed_null": false
600
430
  },
601
431
  {
602
432
  "disabled": false,
603
- "document": "区块链网络id",
604
- "example": "s",
433
+ "document": "设置DID禁用状态的临时凭证内容,通过创建凭证接口(CreateCredential)生成并签名,凭证类型为:OperateCredential, 为安全起见凭证过期时间不适合太长,建议设置为1分钟内",
434
+ "example": "{\\n\\t\\\"cptId\\\": 1,\\n\\t\\\"issuer\\\": \\\"did:tdid:c5:0xe0fd109747937fbaf68ef1f615c2cd8e87d22ffb\\\",\\n\\t\\\"expirationDate\\\": \\\"2023-12-01T10:00:00+08:00\\\",\\n\\t\\\"issuanceDate\\\": \\\"2023-09-19T19:50:52+08:00\\\",\\n\\t\\\"context\\\": \\\"https://github.com/TencentCloud-Blockchain/TDID/blob/main/context/v1\\\",\\n\\t\\\"id\\\": \\\"250d0563e9d680c4d2c33b428913442f\\\",\\n\\t\\\"type\\\": [\\\"VerifiableCredential\\\"],\\n\\t\\\"credentialSubject\\\": {\\n\\t\\t\\\"action\\\": \\\"deactiveDid\\\",\\n\\t\\t\\\"deactivated\\\": \\\"true\\\",\\n\\t\\t\\\"did\\\": \\\"did:tdid:c5:0xe0fd109747937fbaf68ef1f615c2cd8e87d22ffb\\\"\\n\\t},\\n\\t\\\"proof\\\": {\\n\\t\\t\\\"created\\\": \\\"2023-09-19T19:50:52+08:00\\\",\\n\\t\\t\\\"creator\\\": \\\"did:tdid:c5:0xe0fd109747937fbaf68ef1f615c2cd8e87d22ffb#keys-0\\\",\\n\\t\\t\\\"signatureValue\\\": \\\"MEYCIQDSQFpHNt7xltx+dPhwHDrY3kJpMG+hE7Klh/c11Ce3WQIhAOFaISj1kvk8TjrlMaoTAAhoAiriBFj0lLwWyNp69kW7\\\",\\n\\t\\t\\\"type\\\": \\\"Secp256r1\\\",\\n\\t\\t\\\"metaDigest\\\": \\\"9b916ba1e4435f752052fbafe3ed270b61f729feade30fec20aeef4dbac16712\\\",\\n\\t\\t\\\"vcDigest\\\": \\\"692c38a285093f538821f7cce3ddc8358f10f219e991faf226356043228eda24\\\",\\n\\t\\t\\\"privacy\\\": \\\"Public\\\",\\n\\t\\t\\\"salt\\\": {\\n\\t\\t\\t\\\"action\\\": \\\"CTtap\\\",\\n\\t\\t\\t\\\"deactivated\\\": \\\"1jfRX\\\",\\n\\t\\t\\t\\\"did\\\": \\\"D8ukJ\\\"\\n\\t\\t}\\n\\t}\\n}",
605
435
  "member": "string",
606
- "name": "ClusterId",
607
- "required": true,
608
- "type": "string",
609
- "value_allowed_null": false
436
+ "name": "OperateCredential",
437
+ "required": false,
438
+ "type": "string"
610
439
  },
611
440
  {
612
441
  "disabled": false,
613
- "document": "区块链群组id",
442
+ "document": "DID应用Id",
614
443
  "example": "1",
615
444
  "member": "uint64",
616
- "name": "GroupId",
617
- "required": true,
618
- "type": "int",
619
- "value_allowed_null": false
620
- },
621
- {
622
- "disabled": false,
623
- "document": "权威机构did",
624
- "example": "a",
625
- "member": "string",
626
- "name": "Did",
627
- "required": true,
628
- "type": "string",
629
- "value_allowed_null": false
630
- },
631
- {
632
- "disabled": false,
633
- "document": "机构备注信息",
634
- "example": "a",
635
- "member": "string",
636
- "name": "Remark",
637
- "required": true,
638
- "type": "string",
639
- "value_allowed_null": false
640
- },
641
- {
642
- "disabled": false,
643
- "document": "注册时间",
644
- "example": "2022-02-28 17:58:32",
645
- "member": "string",
646
- "name": "RegisterTime",
647
- "required": true,
648
- "type": "string",
649
- "value_allowed_null": false
445
+ "name": "DAPId",
446
+ "required": false,
447
+ "type": "int"
650
448
  },
651
449
  {
652
450
  "disabled": false,
653
- "document": "认证时间",
654
- "example": "2022-02-28 17:58:32",
655
- "member": "string",
656
- "name": "RecognizeTime",
657
- "required": true,
658
- "type": "string",
659
- "value_allowed_null": false
660
- },
661
- {
662
- "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
451
+ "document": "是否禁用",
452
+ "example": "true",
663
453
  "member": "string",
664
- "name": "RequestId",
454
+ "name": "Deactivated",
455
+ "required": false,
665
456
  "type": "string"
666
457
  }
667
458
  ],
668
459
  "type": "object"
669
460
  },
670
- "GetCptInfoRequest": {
671
- "document": "GetCptInfo请求参数结构体",
461
+ "DeactivateTDidResponse": {
462
+ "document": "DeactivateTDid返回参数结构体",
672
463
  "members": [
673
464
  {
674
465
  "disabled": false,
675
- "document": "Cpt索引",
676
- "example": "1",
677
- "member": "uint64",
678
- "name": "CptIndex",
679
- "required": true,
680
- "type": "int"
681
- }
682
- ],
683
- "type": "object"
684
- },
685
- "GetCptInfoResponse": {
686
- "document": "GetCptInfo返回参数结构体",
687
- "members": [
688
- {
689
- "disabled": false,
690
- "document": "CptJsonData的具体信息",
691
- "example": "test",
692
- "member": "string",
693
- "name": "CptJsonData",
694
- "required": true,
695
- "type": "string",
466
+ "document": "上链交易信息",
467
+ "example": "",
468
+ "member": "ChainTransaction",
469
+ "name": "Transaction",
470
+ "output_required": false,
471
+ "type": "object",
696
472
  "value_allowed_null": false
697
473
  },
698
474
  {
@@ -704,33 +480,42 @@
704
480
  ],
705
481
  "type": "object"
706
482
  },
707
- "GetCredentialStatusRequest": {
708
- "document": "GetCredentialStatus请求参数结构体",
483
+ "GetCredentialStateRequest": {
484
+ "document": "GetCredentialState请求参数结构体",
709
485
  "members": [
710
486
  {
711
487
  "disabled": false,
712
- "document": "凭证id",
488
+ "document": "凭证唯一Id",
713
489
  "example": "a",
714
490
  "member": "string",
715
491
  "name": "CredentialId",
716
- "required": true,
492
+ "required": false,
717
493
  "type": "string"
494
+ },
495
+ {
496
+ "disabled": false,
497
+ "document": "用户应用Id",
498
+ "example": "1",
499
+ "member": "uint64",
500
+ "name": "DAPId",
501
+ "required": false,
502
+ "type": "int"
718
503
  }
719
504
  ],
720
505
  "type": "object"
721
506
  },
722
- "GetCredentialStatusResponse": {
723
- "document": "GetCredentialStatus返回参数结构体",
507
+ "GetCredentialStateResponse": {
508
+ "document": "GetCredentialState返回参数结构体",
724
509
  "members": [
725
510
  {
726
511
  "disabled": false,
727
- "document": "凭证状态信息",
512
+ "document": "凭证状态信息\n注意:此字段可能返回 null,表示取不到有效值。",
728
513
  "example": "无",
729
- "member": "CredentialStatus",
730
- "name": "CredentialStatus",
731
- "required": true,
514
+ "member": "CredentialState",
515
+ "name": "CredentialState",
516
+ "output_required": false,
732
517
  "type": "object",
733
- "value_allowed_null": false
518
+ "value_allowed_null": true
734
519
  },
735
520
  {
736
521
  "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
@@ -741,41 +526,40 @@
741
526
  ],
742
527
  "type": "object"
743
528
  },
744
- "GetDidDocumentRequest": {
745
- "document": "GetDidDocument请求参数结构体",
529
+ "GetTDidDocumentRequest": {
530
+ "document": "GetTDidDocument请求参数结构体",
746
531
  "members": [
747
532
  {
748
533
  "disabled": false,
749
- "document": "tdid",
750
- "example": "did:tdid:1:0xa75368ab6ab9cb6d01e81d22155279ee4eca3f4d",
534
+ "document": "DID标识",
535
+ "example": "did:tdid:w1:0xa75368ab6ab9cb6d01e81d22155279ee4eca3f4d",
751
536
  "member": "string",
752
537
  "name": "Did",
753
- "required": true,
538
+ "required": false,
754
539
  "type": "string"
540
+ },
541
+ {
542
+ "disabled": false,
543
+ "document": "DID应用ID",
544
+ "example": "1",
545
+ "member": "uint64",
546
+ "name": "DAPId",
547
+ "required": false,
548
+ "type": "int"
755
549
  }
756
550
  ],
757
551
  "type": "object"
758
552
  },
759
- "GetDidDocumentResponse": {
760
- "document": "GetDidDocument返回参数结构体",
553
+ "GetTDidDocumentResponse": {
554
+ "document": "GetTDidDocument返回参数结构体",
761
555
  "members": [
762
556
  {
763
557
  "disabled": false,
764
- "document": "名称",
765
- "example": "test",
766
- "member": "string",
767
- "name": "Name",
768
- "required": true,
769
- "type": "string",
770
- "value_allowed_null": false
771
- },
772
- {
773
- "disabled": false,
774
- "document": "DID文档",
775
- "example": "s",
558
+ "document": "DID文档内容",
559
+ "example": " ",
776
560
  "member": "string",
777
561
  "name": "Document",
778
- "required": true,
562
+ "output_required": true,
779
563
  "type": "string",
780
564
  "value_allowed_null": false
781
565
  },
@@ -788,154 +572,98 @@
788
572
  ],
789
573
  "type": "object"
790
574
  },
791
- "Proof": {
792
- "document": "验证凭证签名",
575
+ "IssueCredentialRequest": {
576
+ "document": "IssueCredential请求参数结构体",
793
577
  "members": [
794
578
  {
795
579
  "disabled": false,
796
- "document": "创建时间",
797
- "example": "1",
798
- "member": "int64",
799
- "name": "Created",
800
- "required": true,
801
- "type": "int",
802
- "value_allowed_null": false
803
- },
804
- {
805
- "disabled": false,
806
- "document": "创建着did",
807
- "example": "1",
808
- "member": "string",
809
- "name": "Creator",
810
- "required": true,
811
- "type": "string",
812
- "value_allowed_null": false
813
- },
814
- {
815
- "disabled": false,
816
- "document": "salt值",
817
- "example": "1",
818
- "member": "string",
819
- "name": "SaltJson",
820
- "required": true,
821
- "type": "string",
822
- "value_allowed_null": false
580
+ "document": "参数集合,详见示例",
581
+ "example": "",
582
+ "member": "CRDLArg",
583
+ "name": "CRDLArg",
584
+ "required": false,
585
+ "type": "object"
823
586
  },
824
587
  {
825
588
  "disabled": false,
826
- "document": "签名",
827
- "example": "1",
828
- "member": "string",
829
- "name": "SignatureValue",
830
- "required": true,
831
- "type": "string",
832
- "value_allowed_null": false
589
+ "document": "是否未签名",
590
+ "example": "true",
591
+ "member": "bool",
592
+ "name": "UnSigned",
593
+ "required": false,
594
+ "type": "bool"
833
595
  },
834
596
  {
835
597
  "disabled": false,
836
- "document": "type类型",
598
+ "document": "DID应用id",
837
599
  "example": "1",
838
- "member": "string",
839
- "name": "Type",
840
- "required": true,
841
- "type": "string",
842
- "value_allowed_null": false
600
+ "member": "uint64",
601
+ "name": "DAPId",
602
+ "required": false,
603
+ "type": "int"
843
604
  }
844
605
  ],
845
- "usage": "in"
606
+ "type": "object"
846
607
  },
847
- "RegisterCptRequest": {
848
- "document": "RegisterCpt请求参数结构体",
608
+ "IssueCredentialResponse": {
609
+ "document": "IssueCredential返回参数结构体",
849
610
  "members": [
850
611
  {
851
612
  "disabled": false,
852
- "document": "群组ID",
853
- "example": "1",
854
- "member": "uint64",
855
- "name": "GroupId",
856
- "required": true,
857
- "type": "int"
858
- },
859
- {
860
- "disabled": false,
861
- "document": "网络ID",
862
- "example": "bcos-fmtkyt8xne",
613
+ "document": "可验证凭证内容",
614
+ "example": "c",
863
615
  "member": "string",
864
- "name": "ClusterId",
865
- "required": true,
866
- "type": "string"
616
+ "name": "CredentialData",
617
+ "output_required": true,
618
+ "type": "string",
619
+ "value_allowed_null": false
867
620
  },
868
621
  {
869
- "disabled": false,
870
- "document": "CptJson的具体信息",
871
- "example": "test",
622
+ "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
872
623
  "member": "string",
873
- "name": "CptJson",
874
- "required": true,
624
+ "name": "RequestId",
875
625
  "type": "string"
876
- },
877
- {
878
- "disabled": false,
879
- "document": "cptId 不填默认自增",
880
- "example": "1",
881
- "member": "uint64",
882
- "name": "CptId",
883
- "required": false,
884
- "type": "int"
885
626
  }
886
627
  ],
887
628
  "type": "object"
888
629
  },
889
- "RegisterCptResponse": {
890
- "document": "RegisterCpt返回参数结构体",
630
+ "UpdateCredentialStateRequest": {
631
+ "document": "UpdateCredentialState请求参数结构体",
891
632
  "members": [
892
633
  {
893
634
  "disabled": false,
894
- "document": "凭证模板索引",
635
+ "document": "DID应用Id",
895
636
  "example": "1",
896
637
  "member": "uint64",
897
- "name": "Id",
898
- "required": true,
899
- "type": "int",
900
- "value_allowed_null": false
638
+ "name": "DAPId",
639
+ "required": false,
640
+ "type": "int"
901
641
  },
902
642
  {
903
643
  "disabled": false,
904
- "document": "凭证模板id",
905
- "example": "11",
906
- "member": "uint64",
907
- "name": "CptId",
908
- "required": true,
909
- "type": "int",
910
- "value_allowed_null": false
911
- },
912
- {
913
- "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
644
+ "document": "更新VC状态的临时凭证内容,通过创建凭证接口(CreateCredential)生成并签名,凭证类型为:OperateCredential, 为安全起见凭证过期时间不适合太长,建议设置为1分钟内",
645
+ "example": "",
914
646
  "member": "string",
915
- "name": "RequestId",
647
+ "name": "OperateCredential",
648
+ "required": false,
916
649
  "type": "string"
917
650
  }
918
651
  ],
919
652
  "type": "object"
920
653
  },
921
- "SetCredentialStatusRequest": {
922
- "document": "SetCredentialStatus请求参数结构体",
654
+ "UpdateCredentialStateResponse": {
655
+ "document": "UpdateCredentialState返回参数结构体",
923
656
  "members": [
924
657
  {
925
658
  "disabled": false,
926
- "document": "凭证状态",
927
- "example": "test1a152",
928
- "member": "CredentialStatus",
929
- "name": "CredentialStatus",
930
- "required": true,
931
- "type": "object"
932
- }
933
- ],
934
- "type": "object"
935
- },
936
- "SetCredentialStatusResponse": {
937
- "document": "SetCredentialStatus返回参数结构体",
938
- "members": [
659
+ "document": "更新是否成功\n注意:此字段可能返回 null,表示取不到有效值。",
660
+ "example": "true",
661
+ "member": "bool",
662
+ "name": "Result",
663
+ "output_required": false,
664
+ "type": "bool",
665
+ "value_allowed_null": true
666
+ },
939
667
  {
940
668
  "document": "唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。",
941
669
  "member": "string",
@@ -945,39 +673,41 @@
945
673
  ],
946
674
  "type": "object"
947
675
  },
948
- "TransactionArg": {
949
- "document": "创建凭证第二个",
676
+ "VerifyCredentialsRequest": {
677
+ "document": "VerifyCredentials请求参数结构体",
950
678
  "members": [
951
679
  {
952
680
  "disabled": false,
953
- "document": "凭证did",
681
+ "document": "0:仅验证签名,1:验证签名和链上状态,2, 仅验证链上状态,默认为0, 3.验证DID和凭证状态以及签名,4. 验证历史凭证有效性",
954
682
  "example": "1",
683
+ "member": "uint64",
684
+ "name": "VerifyType",
685
+ "required": false,
686
+ "type": "int"
687
+ },
688
+ {
689
+ "disabled": false,
690
+ "document": "凭证内容",
691
+ "example": "{}",
955
692
  "member": "string",
956
- "name": "InvokerTDid",
957
- "required": true,
958
- "type": "string",
959
- "value_allowed_null": false
960
- }
961
- ],
962
- "usage": "in"
963
- },
964
- "VerifyCredentialRequest": {
965
- "document": "VerifyCredential请求参数结构体",
966
- "members": [
693
+ "name": "CredentialData",
694
+ "required": false,
695
+ "type": "string"
696
+ },
967
697
  {
968
698
  "disabled": false,
969
- "document": "参数集合",
699
+ "document": "DID应用id",
970
700
  "example": "1",
971
- "member": "VerifyFunctionArg",
972
- "name": "FunctionArg",
973
- "required": true,
974
- "type": "object"
701
+ "member": "uint64",
702
+ "name": "DAPId",
703
+ "required": false,
704
+ "type": "int"
975
705
  }
976
706
  ],
977
707
  "type": "object"
978
708
  },
979
- "VerifyCredentialResponse": {
980
- "document": "VerifyCredential返回参数结构体",
709
+ "VerifyCredentialsResponse": {
710
+ "document": "VerifyCredentials返回参数结构体",
981
711
  "members": [
982
712
  {
983
713
  "disabled": false,
@@ -985,7 +715,7 @@
985
715
  "example": "True",
986
716
  "member": "bool",
987
717
  "name": "Result",
988
- "required": true,
718
+ "output_required": true,
989
719
  "type": "bool",
990
720
  "value_allowed_null": false
991
721
  },
@@ -995,17 +725,17 @@
995
725
  "example": "0",
996
726
  "member": "uint64",
997
727
  "name": "VerifyCode",
998
- "required": true,
728
+ "output_required": true,
999
729
  "type": "int",
1000
730
  "value_allowed_null": false
1001
731
  },
1002
732
  {
1003
733
  "disabled": false,
1004
- "document": "验证消息",
734
+ "document": "验证结果信息",
1005
735
  "example": "success",
1006
736
  "member": "string",
1007
737
  "name": "VerifyMessage",
1008
- "required": true,
738
+ "output_required": true,
1009
739
  "type": "string",
1010
740
  "value_allowed_null": false
1011
741
  },
@@ -1017,102 +747,6 @@
1017
747
  }
1018
748
  ],
1019
749
  "type": "object"
1020
- },
1021
- "VerifyFunctionArg": {
1022
- "document": "验证凭证参数值",
1023
- "members": [
1024
- {
1025
- "disabled": false,
1026
- "document": "CPT ID",
1027
- "example": "1",
1028
- "member": "uint64",
1029
- "name": "CptId",
1030
- "required": true,
1031
- "type": "int",
1032
- "value_allowed_null": false
1033
- },
1034
- {
1035
- "disabled": false,
1036
- "document": "issuer did",
1037
- "example": "1",
1038
- "member": "string",
1039
- "name": "Issuer",
1040
- "required": true,
1041
- "type": "string",
1042
- "value_allowed_null": false
1043
- },
1044
- {
1045
- "disabled": false,
1046
- "document": "过期时间",
1047
- "example": "1",
1048
- "member": "int64",
1049
- "name": "ExpirationDate",
1050
- "required": true,
1051
- "type": "int",
1052
- "value_allowed_null": false
1053
- },
1054
- {
1055
- "disabled": false,
1056
- "document": "声明",
1057
- "example": "1",
1058
- "member": "string",
1059
- "name": "ClaimJson",
1060
- "required": true,
1061
- "type": "string",
1062
- "value_allowed_null": false
1063
- },
1064
- {
1065
- "disabled": false,
1066
- "document": "颁发时间",
1067
- "example": "1",
1068
- "member": "int64",
1069
- "name": "IssuanceDate",
1070
- "required": true,
1071
- "type": "int",
1072
- "value_allowed_null": false
1073
- },
1074
- {
1075
- "disabled": false,
1076
- "document": "context值",
1077
- "example": "1",
1078
- "member": "string",
1079
- "name": "Context",
1080
- "required": true,
1081
- "type": "string",
1082
- "value_allowed_null": false
1083
- },
1084
- {
1085
- "disabled": false,
1086
- "document": "id值",
1087
- "example": "1",
1088
- "member": "string",
1089
- "name": "Id",
1090
- "required": true,
1091
- "type": "string",
1092
- "value_allowed_null": false
1093
- },
1094
- {
1095
- "disabled": false,
1096
- "document": "签名值",
1097
- "example": "无",
1098
- "member": "Proof",
1099
- "name": "Proof",
1100
- "required": true,
1101
- "type": "object",
1102
- "value_allowed_null": false
1103
- },
1104
- {
1105
- "disabled": false,
1106
- "document": "type值",
1107
- "example": "[\"a\",\"b\"]",
1108
- "member": "string",
1109
- "name": "Type",
1110
- "required": true,
1111
- "type": "list",
1112
- "value_allowed_null": false
1113
- }
1114
- ],
1115
- "usage": "in"
1116
750
  }
1117
751
  },
1118
752
  "version": "1.0"