# OAuth2集成通用方式功能介绍

来源快照：`result_data_new_260518.json`

- 来源 ID：`1173519837073653870`
- 模块：集成中心
- 目录：统一认证接入管理 - 后台维护 - 认证协议套件功能介绍
- space ID：`1158011075224911873`
- 原文链接：未提供
- 产品基线：未提供

## 正文

## 一、功能背景及价值用途

E10支持通过OAuth2.0认证协议接入第三方认证服务，实现免登录效果。

## 二、业务流程图/配置过程图

暂无。

## 三、功能概述及使用说明

OAuth2认证方式可支持通用方式，以及微软AAD集成、微软AAD_JWT集成、竹云认证集成、派拉集成、蓝信集成、吉大正元集成、keycloak集成等套件。

通用方式中所有配置均为空，均可支持自定义配置。其他套件方式中均已根据对应第三方认证服务接口内置了相关参数，如需调整亦可手动调整相关配置。

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519892944601092&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

本文档主要介绍OAuth2.0集成通用方式配置。

配置OAuth2集成功能之前，需联系认证服务提供相关接口说明文档，以文档为依据配置相关接口即可。

### 3.1 功能配置

在协议面板OAuth2.0认证方式处，选择OAuth2.0集成通用方式、认证类型后，进入OAuth2.0集成通用方式配置页面，所有配置均为空白，请根据第三方认证服务提供的相关接口进行配置。

选择协议类型为OAuth2.0集成通用方式、认证类型后，进入详细配置页面。

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519884355698706&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

1）基本信息：

应用标识、应用密钥：统一认证平台注册应用后提供。

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519888642277377&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

 

2）请求用户授权接口：根据统一认证平台提供的接口进行配置接口地址、请求方式、取值字段、接口所需参数。

其中，取值字段是设置授权接口返回的授权码参数名称。

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519888642277389&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

3）获取授权Token接口：根据统一认证平台提供的接口进行配置接口地址、请求方式、解析格式、获取令牌字段、刷新令牌字段、接口所需参数。

其中，

解析格式可支持返回数据为JSON、文本、XML格式的数据；

获取令牌字段是设置token接口中返回授权token令牌的参数名称；

刷新令牌字段是设置token接口中返回的刷新token令牌的参数名称，不使用刷新token接口时，无需配置。

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519888764780564&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

 

4）刷新Token接口：默认关闭。根据统一认证平台提供的接口进行配置接口地址、请求方式、解析格式、获取令牌字段、刷新令牌字段、刷新时间及接口所需参数。

其中，

获取令牌字段配置刷新token接口返回数据中新获取的授权token令牌的参数名称；

刷新令牌字段配置刷新token接口返回数据中新获取的刷新token令牌的参数名称；

刷新时间可根据实际需求进行配置，但需注意，可输入的范围值是900s~86400s，即15分钟~1天。

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519888764780547&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

刷新逻辑：

在认证登录后，根据刷新时间创建定时任务，定时请求刷新token接口，其中，需注意：

务必确保【后台管理中心】-【全局基础】-【插件管理】插件列表中存在“OAuth2集成支持刷新token”插件，且为启用状态。

若没有，可新建一下插件配置：

模块：intunifyauthclient

描述：OAuth2集成支持刷新token

仓库名：@weapp/integration

组件名：RefreshTokenPlugin

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519897323454475&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

 

5）校验Token接口：默认关闭。根据统一认证平台提供的接口进行配置接口地址、请求方式、解析格式、取值字段、校验值及接口所需参数。

其中，取值字段是获取校验Token接口返回的进行校验的字段名称；校验值是需要进行校验的取值，可自定义输入，也支持选择系统默认的参数属性。

校验逻辑：

在调用统一退出接口时先调用校验Token接口，获取取值字段的值，与校验值进行对比，匹配成功则说明token有效，匹配失败则说明token无效。

注：目前校验Token接口仅在调用统一退出前进行校验，其他场景暂不支持。

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519893034582025&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

 

6）获取用户信息接口：根据统一认证平台提供的接口进行配置接口地址、请求方式、账号规则、取值字段、接口所需参数。

其中，取值字段是设置用户信息接口返回的人员参数字段，需确保取值字段值与账号规则选择的字段值一致的。

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519892944601099&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

 

7）统一退出接口：根据统一认证平台提供的接口进行配置接口地址、请求方式、接口所需参数。

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519888764780554&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

 

8）检测心跳接口：根据统一认证平台提供的接口进行配置接口地址、请求方式、心跳正常标记、接口所需参数。其中，心跳正常标记：配置心跳接口正常返回的结果。开启后，会先调用心跳接口，将在接口返回值中检索，若包含心跳正常标记内容，则进行认证登录，匹配不上则跳转OA自己的登录页面。

心跳失败跳转地址：用于检测心跳接口异常时，支持自定义异常跳转的页面地址。非必填，不配置时，默认会跳转到OA自己的登录页面，若配置了，则跳转配置的页面。（10.0.2501.01基线支持）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519893079351308&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

 

9)参数设置：请问用户授权接口、获取授权Token接口、刷新Token接口、校验Token接口、获取用户信息接口、统一退出接口、检测心跳接口，这些接口都可以配置参数设置，根据提供的实际接口所需参数进行配置。

其中，请求头参数支持Base64编码。

当第三方要求请求头传Basic 应用标识:应用秘钥且参数值需要Base64编码是，选择对应加密方式即可，示例如下：

Authorization   Basic ${client_id}:${client_id}

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519892944601090&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

当请求头参数要求传Bearer access_token值，请切换成文本输入框，参考下述配置：

Authorization   Bearer ${access_token}

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519888641245197&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

 

请求头-内容，请求参数-参数值支持选择浏览框数据以及手动输入。

浏览框支持选择：

${client_id}：获取基本信息中配置的应用标识

${client_secret}：获取基本信息中配置的应用密钥

${redirect_uri}：获取E10回调地址

${code}：获取授权接口返回的授权码

${access_token}：获取Token接口返回的token

${timestamp}：获取当前系统时间，精确到毫秒

${short_timestamp}：获取当前系统时间，精确到秒

${date}：获取当前日期，格式yyyy-MM-dd

${time}：获取当前时间，格式HH:mm:ss

${dateandtime}：获取当前日期时间，格式yyyy-MM-dd HH:mm:ss

${state}：获取8位随机字符串

${state_security}：获取8位随机字符串，并对认证客户端IP做授权回调安全校验

${refresh_token}：获取token接口返回的刷新令牌

${app_token}：获取蓝信应用Token接口返回的token（仅蓝信集成套件可使用）

${user_token}：获取蓝信用户Token接口返回的token（仅蓝信集成套件可使用）

${paasId}：获取基本信息中竹云网关集成应用标识（仅竹云认证集成套件可使用）

${paasToken}：获取基本信息中竹云网关集成应用密钥（仅竹云认证集成套件可使用）

${x_tif_signature}：获取竹云网关计算签名时间戳，精确到毫秒（仅竹云网关认证套件可使用）

${x_tif_nonce}：获取竹云网关计算签名随机字符串（仅竹云网关认证套件可使用）

![](https://weapp.eteams.cn/papi/file/preview?fileId=1173519888641245188&type=redirect&customParam=%7B%22isExtDist%22%3Atrue%2C%22distributeId%22%3A%22%22%2C%22externalId%22%3A%22%22%2C%22appId%22%3A%22%22%7D)

### 3.2 配置示例

E10接入Ecology系列系统配置说明请参考：

《[ _E10系统通过OAuth2集成接入另一套E10系统_](https://www.e-cology.com.cn/sp/doc/docDetail/2004843376417310566) 》：

[https://weapp.eteams.cn/sp/ebdpage/view/freepass/1152863419640021002?id=1174730476735709219&freepass_doc=1&space_id=1158011075224911873](https://weapp.eteams.cn/sp/ebdpage/view/freepass/1152863419640021002?id=1174730476735709219&freepass_doc=1&space_id=1158011075224911873)

《[ _E10系统通过OAuth2集成接入E9系统_](https://www.e-cology.com.cn/sp/doc/docDetail/100500240011506766) 》：

[https://weapp.eteams.cn/sp/ebdpage/view/freepass/1152863419640021002?id=1174723089509400593&freepass_doc=1&space_id=1158011075224911873](https://weapp.eteams.cn/sp/ebdpage/view/freepass/1152863419640021002?id=1174723089509400593&freepass_doc=1&space_id=1158011075224911873)

## 四、延伸用法

无。

## 五、使用注意点

无。

##
