API 参考
YeeAuth REST API 接口文档总览
API 参考
本节文档由 YeeAuth 后端服务的 OpenAPI 规范(openapi.json)自动生成,覆盖账户认证、用户与组织、权限与策略、应用与多租户等全部 REST 接口。所有接口按分类(tag)组织在左侧导航中,每个接口页面包含请求方法与路径、请求参数、请求体、响应结构,并提供可交互的调试面板。
基础信息
| 项 | 值 |
|---|---|
| 接口标题 | Yeeauth Iam Open API |
| 版本 | v0.0.1 |
| 基础地址 | https://app.yeeauth.com |
认证方式
大多数接口需要携带身份凭证,YeeAuth 提供两种认证机制:
- Bearer Token(JWT):在请求头中加入
Authorization: Bearer <token>,令牌由 OAuth2 / OIDC 流程颁发。 - 用户池标识:在请求头中加入
x-userpool-id: <userpool-id>,用于标识当前操作所属的用户池(租户隔离单元)。
具体某个接口所需的认证项,以该接口页面的「Authorization」说明为准。
接口分类
左侧导航按业务域组织了全部接口分类,主要分组如下:
账户与登录
- 账户登陆
- 账户注册
- 会话管理
- 单点登录及应用面板
- saml2
用户与身份
- 用户管理 / 用户管理V2
- 个人中心 / 个人中心管理
- 身份源管理
- AI Agent 身份
组织与分组
- 用户池管理
- 组织机构管理 / 组织机构管理(v3)
- 分组管理
权限与访问控制
- 角色管理
- 权限管理
- 资源管理
- 策略管理
应用管理
- 应用管理 / 应用管理V2
多租户
- 租户管理
- 租户成员管理
- 租户应用可见性管理
平台能力
- Webhook 管理
- 统计分析
- 存储服务