WeIdDocument¶
属性
com.webank.weid.protocol.base.WeIdDocument
| 名称 | 类型 | 说明 | 备注 |
|---|---|---|---|
| id | String | WeIdentity DID | |
| created | Long | 创建时间 | |
| updated | Long | 更新时间 | |
| publicKey | List |
列出公钥集合，见下 | |
| authentication | List |
认证方集合，见下 | |
| service | List |
服务端点集合，见下 |
com.webank.weid.protocol.base.PublicKeyProperty
| 名称 | 类型 | 说明 | 备注 |
|---|---|---|---|
| id | String | ||
| type | String | 类型 | 默认为：Secp256k1 |
| owner | String | 拥有者WeIdentity DID | |
| publicKey | String | 数字公钥 |
com.webank.weid.protocol.base.AuthenticationProperty
| 名称 | 类型 | 说明 | 备注 |
|---|---|---|---|
| type | String | 类型 | 默认为：Secp256k1 |
| publicKey | String |
com.webank.weid.protocol.base.ServiceProperty
| 名称 | 类型 | 说明 | 备注 |
|---|---|---|---|
| type | String | 类型 | |
| serviceEndpoint | String |
方法
1. toJson¶
基本信息
接口名称:com.webank.weid.protocol.base.WeIdDocument.toJson()
接口定义:String toJson()
接口描述: 将WeIdDocument转换成json格式的字符串。
注意：此方法转换出错会抛DATA_TYPE_CASE_ERROR异常 。
此方法返回code
| enum | code | desc |
|---|---|---|
| DATA_TYPE_CASE_ERROR | 160008 | 数据转换异常 |
调用示例
2. fromJson¶
基本信息
接口名称:com.webank.weid.protocol.base.WeIdDocument.fromJson(String weIdDocumentJson)
接口定义:WeIdDocument fromJson(String weIdDocumentJson)
接口描述: 将json格式的WeIdDocument转换成WeIdDocument对象。
注意：调用fromJson(String weIdDocumentJson)的入参，必须是通过调用toJson()得到的json格式的WeIdDocument字符串，否则会抛异常 。
此方法返回code
| enum | code | desc |
|---|---|---|
| DATA_TYPE_CASE_ERROR | 160008 | 数据转换异常 |
调用示例
Challenge¶
属性
com.webank.weid.protocol.base.Challenge
| 名称 | 类型 | 非空 | 说明 | 备注 |
|---|---|---|---|---|
| weId | String | N | WeIdentity DID | policy提供给指定的WeIdentity DID |
| version | Integer | Y | 版本 | |
| nonce | String | Y | 随机字符串 |
方法
1. toJson¶
基本信息
接口名称:com.webank.weid.protocol.base.Challenge.toJson()
接口定义:String toJson()
接口描述: 将Challenge转换成json格式的字符串。
注意：此方法转换出错会抛DATA_TYPE_CASE_ERROR异常 。
此方法返回code
| enum | code | desc |
|---|---|---|
| DATA_TYPE_CASE_ERROR | 160008 | 数据转换异常 |
调用示例
2. fromJson¶
基本信息
接口名称:com.webank.weid.protocol.base.Challenge.fromJson(String challengeJson)
接口定义:Challenge fromJson(String challengeJson)
接口描述: 将json格式的Challenge转换成Challenge对象。
注意：调用fromJson(String challengeJson)的入参，必须是通过调用toJson()得到的json格式的Challenge字符串，否则会抛DATA_TYPE_CASE_ERROR异常 。
此方法返回code
| enum | code | desc |
|---|---|---|
| DATA_TYPE_CASE_ERROR | 160008 | 数据转换异常 |
调用示例
CredentialPojo¶
属性
com.webank.weid.protocol.base.CredentialPojo
| 名称 | 类型 | 说明 | 备注 |
|---|---|---|---|
| context | String | ||
| type | List<String> | ||
| id | String | 证书ID | |
| cptId | Integer | cptId | |
| issuer | String | issuer 的 WeIdentity DID | |
| issuanceDate | Long | 创建日期 | |
| expirationDate | Long | 到期日期 | |
| claim | Map<String, Object> | Claim数据 | |
| proof | Map<String, Object> | 签名数据结构体 |
方法
1. toJson¶
基本信息
接口名称:com.webank.weid.protocol.base.CredentialPojo.toJson()
接口定义:String toJson()
接口描述: 将CredentialPojo转换成json格式的字符串。
注意：此方法转换出错会抛DATA_TYPE_CASE_ERROR异常 。
此方法返回code
| enum | code | desc |
|---|---|---|
| DATA_TYPE_CASE_ERROR | 160008 | 数据转换异常 |
调用示例
2. fromJson¶
基本信息
接口名称:com.webank.weid.protocol.base.CredentialPojo.fromJson(String credentialPojoJson)
接口定义:CredentialPojo fromJson(String credentialPojoJson)
接口描述: 将json格式的CredentialPojo转换成CredentialPojo对象。
注意：调用fromJson(String credentialPojoJson)的入参，必须是通过调用toJson()得到的json格式的CredentialPojo字符串，否则会抛异常 。
此方法返回code
| enum | code | desc |
|---|---|---|
| DATA_TYPE_CASE_ERROR | 160008 | 数据转换异常 |
调用示例
PresentationPolicyE¶
属性
com.webank.weid.protocol.base.PresentationPolicyE
| 名称 | 类型 | 非空 | 说明 | 备注 |
|---|---|---|---|---|
| id | Integer | Y | polcyId | 策略编号 |
| orgId | String | Y | 机构编号 | |
| version | Integer | Y | 版本 | |
| policyPublisherWeId | String | Y | WeIdentity DID | 创建policy机构的WeIdentity DID |
| policy | Map<Integer, ClaimPolicy> | Y | 策略配置 | key: CPTID, value: 披露策略对象 |
| extra | Map<String, String> | N | 扩展字段 |
方法
1. toJson¶
基本信息
接口名称:com.webank.weid.protocol.base.PresentationPolicyE.toJson()
接口定义:String toJson()
接口描述: 将PresentationPolicyE转换成json格式的字符串。
注意：此方法转换出错会抛DATA_TYPE_CASE_ERROR异常 。
此方法返回code
| enum | code | desc |
|---|---|---|
| DATA_TYPE_CASE_ERROR | 160008 | 数据转换异常 |
调用示例
2. fromJson¶
基本信息
接口名称:com.webank.weid.protocol.base.PresentationPolicyE.fromJson(String presentationPolicyEJson)
接口定义:PresentationPolicyE fromJson(String presentationPolicyEJson)
接口描述: 将json格式的PresentationPolicyE转换成PresentationPolicyE对象。
注意：调用fromJson(String presentationPolicyEJson)的入参，必须是通过调用toJson()得到的json格式的PresentationPolicyE字符串，否则会抛异常 。
此方法返回code
| enum | code | desc |
|---|---|---|
| DATA_TYPE_CASE_ERROR | 160008 | 数据转换异常 |
调用示例
PresentationE¶
属性
com.webank.weid.protocol.base.PresentationE
| 名称 | 类型 | 非空 | 说明 | 备注 |
|---|---|---|---|---|
| context | List<String> | Y | 上下文 | |
| type | List<String> | Y | Presentation Type | |
| credentialList | List<CredentialPojo> | Y | 凭证列表 | |
| proof | Map<String, Object> | Y | Presentation的签名信息 |
方法
1. toJson¶
基本信息
接口名称:com.webank.weid.protocol.base.PresentationE.toJson()
接口定义:String toJson()
接口描述: 将PresentationE转换成json格式的字符串。
注意：此方法转换出错会抛DATA_TYPE_CASE_ERROR异常 。
此方法返回code
| enum | code | desc |
|---|---|---|
| DATA_TYPE_CASE_ERROR | 160008 | 数据转换异常 |
调用示例
2. fromJson¶
基本信息
接口名称:com.webank.weid.protocol.base.PresentationE.fromJson(String presentationEJson)
接口定义:PresentationE fromJson(String challengeJson)
接口描述: 将json格式的PresentationE转换成PresentationE对象。
注意：调用fromJson(String presentationEJson)的入参，必须是通过调用toJson()得到的json格式的PresentationE字符串，否则会抛异常 。
此方法返回code
| enum | code | desc |
|---|---|---|
| DATA_TYPE_CASE_ERROR | 160008 | 数据转换异常 |
调用示例
3. push¶
基本信息
接口名称: com.webank.weid.protocol.base.PresentationE.push
接口定义: boolean push(CredentialPojo credentialPojo)
接口描述: 将非policy里面的Credential添加到Presentation中
注意：调用 push(CredentialPojo credentialPojo) 添加完所有Credential后需要调用 commit(WeIdAuthentication weIdAuthentication) 进行重新签名，否则验证Presentation时会失败
调用示例
4. commit¶
基本信息
接口名称: com.webank.weid.protocol.base.PresentationE.commit
接口定义: boolean commit(WeIdAuthentication weIdAuthentication)
接口描述: 添加完Credential对Presentation重新签名处理了
调用示例