组织用户加密消息 - EncryptMessageForOrgUser
功能介绍
组织用户加密消息接口,调用接口需要配置组织用户的TLS证书。组织用户的TLS证书可以从BCS服务实例概览页面下载配置文件获得。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/e2ee/org/encrypt
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
target_org_ids | 是 | Array of strings | 可以解密消息的组织ID |
message | 是 | String | 组织的用户输入需要加密的信息 |
up_to_chain | 否 | Boolean | 是否加密后发送到链上,参数取值如下: true:加密后发送到链上,默认为true false:加密后不发送到链上 |
update_group_key | 否 | Boolean | 是否更新组密钥,参数取值如下: true:更新组密钥 false:不更新组密钥 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
transaction_id | String | 消息加密后对应的交易ID,用于查询解密后明文 |
data_to_chain | Array of strings | 非代为上链场景下,加密后的密文,需要在SDK侧完成上链 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误信息 |
请求示例
加密一条消息,允许组织ID为“organization2-kdkvs88qk”的组织解密该消息,由E2EE服务代为上链,不更新组密钥。url中变量{domain}由服务IP地址和端口号组成。从BCS实例的插件管理页面可以获取服务ip地址,插件详情页面可以获取组织的端口号。
https://{{domain}}/v1/e2ee/org/encrypt
{
"message" : "hello, this test message",
"target_org_ids" : [ "organization2-kdkvs88qk" ],
"up_to_chain" : true,
"update_group_key" : false
} 响应示例
状态码:200
成功响应
{
"transaction_id" : "1feda96bbf878fe856f9801aed3de107c0dc832996ac6f99d8821350dc6c37c5",
"data_to_chain" : null
} 状态码
状态码 | 描述 |
|---|---|
200 | 成功响应 |
400 | 错误响应 |

