yapi-plugin-pl-oauth2
v1.1.0
Published
yapi plugin for sso,with oauth2
Downloads
13
Readme
yapi-plugin-pl-oauth2
第三方插件,基于 Oauth2 协议登录,在生成的配置文件中,添加如下配置即可:
"plugins": [
{
"name":"pl-oauth2",
"options":{
"userUrl":"http://sso.server.com/auth/realms/realmA/protocol/openid-connect/userinfo",
"authUrl":"http://sso.server.com/auth/realms/realmA/protocol/openid-connect/auth",
"tokenUrl":"http://sso.server.com/auth/realms/realmA/protocol/openid-connect/token",
"clientId":"******",
"clientSecret":"*******",
"emailKey":"emailKey",
"userKey":"userKey",
"emailPostfix":"@yapi.com",
"yapiHost":"yapi.server.com",
"buttonName":"nameUwhant",
"otherAttris":"avatar,family_name"
}
}
]
使用注意:
- Oauth2 服务器用户信息需要提供:
email
和username
两个字段,如果字段名不一致,可以通过emailKey
和userKey
设置,如果没有电子邮箱字段,可以使用用户名字段+emailPostfix
属性设置默认电子邮箱地址(电子邮箱是 Yapi 用户唯一标志),如果有emailKey
默认使用emailKey
获取邮箱信息 - sso.server.com 如果部署在容器中,注意确认容器中的网络要与 yapi.server.com 保持通畅,否则会出现 sso 登录成功,但是 yapi 显示未登录的情况
这里面的配置项含义如下:
userUrl
oauth2 服务器登录后获取用户信息访问 endpointauthUrl
oauth2 服务器的授权 endpointtokenUrl
oauth2 服务器获取 token 的 endpointclientId
oauth2 服务器 clientIdclientSecret
oauth2 服务器 clientSecretemailKey
用户信息电子邮件字段 keyuserKey
用户信息用户名字段 keyemailPostfix
邮箱后缀yapiHost
yapi 的 HostbuttonName
yapi 首页的登录按钮显示名称otherAttris
oauth2 服务器返回的用户属性,可同步至yapi,也可为空