1. 接口描述
接口请求域名： bhsaas.api3.fincloud.tencent.com。
设置OAuth认证参数
默认接口请求频率限制：20次/秒。
接口更新时间：2025-01-23 14:32:02。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ModifyOAuthSetting |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-10-18 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| AuthMethod | 否 | 是 | String | OAuth认证方式。 示例值： okta |
| ClientId | 否 | 是 | String | OAuth认证客户端Id 示例值： client-id |
| ClientSecret | 否 | 是 | String | OAuth认证客户端密钥 示例值： client-secret |
| CodeUrl | 否 | 是 | String | 获取OAuth认证授权码URL 示例值： https://some-url/oauth2/v1/authorize |
| TokenUrl | 否 | 是 | String | 获取OAuth令牌URL 示例值： https://some-url/oauth2/v1/token |
| UserInfoUrl | 否 | 是 | String | 获取OAuth用户信息URL 示例值： https://some-url/oauth2/v1/userinfo |
| Scopes | 否 | 是 | Array of String | 使用Okta认证时指定范围。为空时默认使用 openid、profile、email。 示例值： ["email"] |
| Enable | 是 | 是 | Bool | 是否开启OAuth认证，false-不开启，true-开启。 示例值： true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| UnknownParameter | 未知参数错误。 |
| InternalError | 内部错误。 |
| UnauthorizedOperation | 未授权操作。 |
| FailedOperation | 操作失败。 |
| AuthFailure | CAM签名/鉴权错误。 |
| OperationDenied | 操作被拒绝。 |
| UnauthorizedOperation.NoPermission | 无操作权限。 |