licos-platform-sdk
LICOS 项目服务端 SDK,提供项目数据库、对象存储、企业知识库、本体和 OAuth 等平台能力。
项目登录身份
有内置登录用项目当前会话,没有内置登录用 LICOS 网页登录。显式配置模式,不按凭证是否存在切换身份:
from licos_platform_sdk import ProjectAuth, get_current_user
project_auth = ProjectAuth("platform")
token = project_auth.user_token(request)
user = get_current_user(user_token=token)
platform 模式接受调用方明确提供的 Bearer Token,或浏览器登录桥签发的 X-Licos-User-Ticket;两者同时出现会报错。票据只兑换一次,绑定 LICOS_PROJECT_ID,服务端使用 LICOS_AI_AGENT_TOKEN 兑换;不会根据初始化用户换 Token。
内置登录使用 ProjectAuth("builtin", resolve_builtin_token=已有会话取值函数),取值函数只返回该登录用户已授权的 LICOS Token。它缺失或失效时返回内置登录错误,不读取平台票据或容器用户。业务自签 JWT 不能直接传给平台 SDK。
Agent/Workflow 的请求节点使用 ctx.identity.user_token。异步 HTTP 处理器用 await asyncio.to_thread(project_auth.user_token, request) 完成票据兑换,避免阻塞事件循环。
沿用现有 OAuth 授权范围与接口权限。凭证无权访问目标接口时返回现有鉴权错误,不扩大权限或换用其他身份。
当前使用者信息(0.6.1 起)
from licos_platform_sdk import get_current_user
# token 是当前请求的用户 Bearer Token,不包含 "Bearer " 前缀。
sys_user = get_current_user(user_token=token)
print(sys_user["displayName"])
print(sys_user["departments"])
print(sys_user["primaryPosition"])
返回对象与低代码系统变量 sys_user 相同,保留平台的 camelCase 字段名:
id、username、displayName、avatarUrl、tenantId、tenantName、
primaryDepartment、departments、organizationAssignments、primaryPosition、primaryJobTitle。
部门包含 ID、名称、组织路径、ID 路径及主部门标志;组织任职包含岗位、职务和部门负责人标志。
SDK 自动读取 LICOS_PLATFORM_API_BASE_URL、LICOS_AI_AGENT_TOKEN 和项目工作空间。
workspace_id 可由服务端指定执行工作空间;默认依次读取 LICOS_WORKSPACE_ID、
LICOS_OWNER_WORKSPACE_ID、AGENT_WORKSPACE_ID。企业按执行工作空间确定,与低代码一致。
无企业时企业字段为 None;未加入执行企业的使用者,部门和任职为空,不能返回项目所有者的信息。
多用户服务每次传入当前请求的 Token。智能体/工作流可传 ctx.identity.user_token;
在异步节点中使用 await asyncio.to_thread(get_current_user, user_token=token)。
结果不做全局缓存。Token 无效时直接报错,由调用方处理登录失效。
从 0.7.0 起必须显式传入 user_token。LICOS_CURRENT_USER_ID 只是容器初始化用户,不能代表网页登录者。
本接口仅供服务端使用;LICOS_AI_AGENT_TOKEN 不得发送到浏览器。
身份选择(0.7.0 起)
LICOS_CURRENT_USER_ID 表示容器启动时配置的执行用户。SDK 不用它推断当前网页登录者,也不从进程级 LICOS_USER_TOKEN 取得本次请求凭证。项目身份指运行时配置的项目所有者身份,按接口选择:
| 接口 | 调用身份 |
|---|---|
get_current_user |
必须显式传入本次用户的 user_token |
enterprise_knowledge 全部接口 |
必须传 user_token,企业范围和权限由平台认证结果确定 |
本体 search_tools、resolve_tool、invoke_tool、subscribe_realtime |
必须传执行用户的 user_token;网页登录请求使用本次登录会话的 Token |
普通 knowledge 接口 |
默认项目身份;需要用户权限时显式传 user_token |
数据库、对象存储、oauth 应用管理 |
项目身份 |
oauth_runtime 授权码交换、刷新、userinfo、撤销 |
按 OAuth 协议传对应凭证,不使用容器用户替代 |
user_token 不含 Bearer 前缀。用户标识、名称和企业信息以平台认证结果为准;项目所有者、工作空间等资源归属字段单独保留。
from licos_platform_sdk import enterprise_knowledge, get_current_user, knowledge, ontology
# token 来自本次请求的认证会话。
user = get_current_user(user_token=token)
resources = enterprise_knowledge.tree(user_token=token)
catalog = ontology.search_tools('设备状态', user_token=token)
result = knowledge.search('资料', user_token=token)
网页登录请求缺少 Token 时,业务入口应返回登录错误,不能改用容器用户或项目所有者。每次调用显式传入 Token,不把请求 Token 或用户 ID 写入 os.environ,也不跨用户共享请求身份。
显式传入的 Token 失效时直接返回鉴权错误,由调用方更新登录凭证。实时订阅遇到网络中断会携带原 Token 重新检查授权并订阅,401/403 终止;取得新 Token 后重新创建订阅。后台常驻的项目订阅由调用方显式传项目所有者 Token。
独立 licos-platform CLI 的用户操作才默认按 LICOS_CURRENT_USER_ID 和运行时服务凭证换 Token。HTTP 服务通过 CLI 调用用户接口时使用 --token-stdin,不依赖容器默认用户。升级到 0.7.0 时,已有企业知识库和本体调用必须补上 user_token 参数。
Metadata
Release files for licos-platform-sdk 0.7.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| licos_platform_sdk-0.7.3.tar.gz | 49.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| licos_platform_sdk-0.7.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 92.7 kB
Release files / licos_platform_sdk-0.7.3.tar.gz
| Download URL | licos_platform_sdk-0.7.3.tar.gz |
|---|---|
| Size | 49.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f2223ce4318c9993427548848030ea4d1c96ae4a88821a76b6cf4012cdcaddc4
|
|
BLAKE2b-256 checksum How to use checksums |
aeb5fecf1987ea6773d5643cda57fc491e3bb7b8c3caf8bf243f330afcc0d470
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|
Release files / licos_platform_sdk-0.7.3-py3-none-any.whl
| Download URL | licos_platform_sdk-0.7.3-py3-none-any.whl |
|---|---|
| Size | 43.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d2c2052b22d19ea7f88849461c44e44ba0e3d4ff2f7ba620c9ceea4bd92f9a53
|
|
BLAKE2b-256 checksum How to use checksums |
463ff76232583aef3fd2bd654cde8e640360af8c23f7dbe4694c6eece2d3fe3e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|