接口介绍
MetadataClient 提供
verify_auth 接口,用于验证用户密钥(User Key)的有效性。该接口可用于在业务逻辑中校验用户身份是否合法。verify_auth:验证用户密钥是否有效,返回验证结果和关联的用户信息。
导入
from tencentdb_agent_memory.v3 import MetadataClient
方法签名
def verify_auth(self, user_key: str) -> Dict[str, Any]
使用示例
verify_auth
from tencentdb_agent_memory.v3 import MetadataClientmetadata = MetadataClient(endpoint="https://memory.tdai.tencentyun.com",api_key="sk-xxxxxxxxxxxxxxxx",service_id="tdai-mem-xxxxxxxx",)resp = metadata.verify_auth("sk-mem-xxxxxxxxxxxxxxxxxxxx")print(resp["valid"])
请求参数
verify_auth
参数名 | 类型 | 必填 | 描述说明 |
user_key | str | 是 | 待验证的用户密钥 |
响应示例
verify_auth
{"valid": true,"user_id": "user-123","key_id": "key-abc","status": "active"}
响应参数说明
参数名 | 类型 | 参数含义 |
valid | bool | 密钥是否有效 |
user_id | str | 密钥关联的用户 ID |
key_id | str | 密钥 ID |
status | str | 密钥状态,如 active、revoked |
错误码
错误码 | 触发场景 | 处理建议 |
400 | user_key 参数为空 | 检查参数 |
401 | API Key 无效或缺失 | 检查 Bearer Token 配置 |
500 | 服务内部错误 | 稍后重试 |