快速入门
准备工作
接入 YeeAuth 之前需要完成的配置:创建组织与应用、获取凭据、记录关键端点。
准备工作
在编写任何代码之前,你需要先在 YeeAuth Console 中完成基础配置,并记录几项关键信息。本页结束时,你应当已经持有一组可用的凭据和端点地址。
创建组织和应用
- 登录 YeeAuth Console(管理控制台)。
- 在左侧导航栏中选择 Organizations(组织),点击新建,创建一个属于你的组织。
- 进入该组织后,选择 Applications(应用程序),点击新建应用。
- 填写应用名称,并根据应用类型(如单页应用 SPA、Web 应用、移动端等)选择合适的模板。
- 配置 Redirect URIs(重定向回调地址),即用户登录成功后 YeeAuth 把用户跳回的地址。它必须与你后续发起登录时传入的
redirect_uri完全一致(包括协议、域名、端口、路径)。
开发阶段可以先填本地地址,例如
http://localhost:3000/callback。上线前记得替换为正式域名。
获取凭据
应用创建成功后,你将获得以下关键信息,请妥善保存:
| 凭据 | 说明 |
|---|---|
| Client ID | 应用程序的唯一标识,前后端均可见 |
| Client Secret | 仅用于机密客户端(如后端服务器),切勿暴露在浏览器或移动端代码中 |
| Issuer URL | 你的 YeeAuth 授权服务器地址,例如 https://iam.3as.cn |
Client Secret 通常只在创建时完整展示一次,请第一时间复制保存。若丢失,需要在控制台重新生成。
记录关键端点
YeeAuth 完全兼容 OAuth 2.0 / OIDC。所有端点都可以通过 OIDC 发现文档自动获取,访问以下地址即可拿到一份 JSON 配置:
GET {Issuer URL}/.well-known/openid-configuration返回内容中包含了你接入时需要用到的全部端点。以 Issuer 为 https://iam.3as.cn 为例:
| 端点 | 地址 | 用途 |
|---|---|---|
| Authorization Endpoint | https://iam.3as.cn/oauth/authorize | 引导用户登录并获取授权码 |
| Token Endpoint | https://iam.3as.cn/oauth/token | 用授权码换取 Token |
| Userinfo Endpoint | https://iam.3as.cn/userinfo | 获取已认证用户的详细信息 |
| JWKS Endpoint | https://iam.3as.cn/oauth/jwks | 获取验签公钥,供资源服务校验 Token |
发现文档还会告诉你服务端支持的能力,其中常用的包括:
- 支持的授权类型(grant_types):
authorization_code、password、client_credentials、refresh_token。 - 支持的权限范围(scopes):
openid、profile、email、phone、address。 - ID Token 签名算法:
RS256。
建议始终从
.well-known/openid-configuration动态读取端点,而不是把地址硬编码到代码里,这样在 Issuer 变更或多环境切换时无需改动代码。
下一步
凭据和端点都准备好后,就可以进入 接入用户登录,完成第一次真正的登录流程。