设置OAuth认证参数

最近更新时间:2024-11-07 01:25:54

我的收藏

1. 接口描述

接口请求域名: dasb.tencentcloudapi.com 。

设置OAuth认证参数

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyOAuthSetting。
Version String 公共参数,本接口取值:2019-10-18。
Region String 公共参数,详见产品支持的 地域列表
Enable Boolean 是否开启OAuth认证,false-不开启,true-开启。
示例值:false
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.N Array of String 使用Okta认证时指定范围。为空时默认使用 openid、profile、email。
示例值:["profile"]

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 设置Okta认证配置

输入示例

POST / HTTP/1.1
Host: dasb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyOAuthSetting
<公共请求参数>

{
    "Enable": true,
    "AuthMethod": "okta",
    "ClientId": "client-id",
    "ClientSecret": "client-secret",
    "CodeUrl": "https://some-url/oauth2/v1/authorize",
    "TokenUrl": "https://some-url/oauth2/v1/token",
    "UserInfoUrl": "https://some-url/oauth2/v1/userinfo"
}

输出示例

{
    "Response": {
        "RequestId": "dfac9070-8b23-499e-83b2-a50e3ca059af"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
OperationDenied 操作被拒绝。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NoPermission 无操作权限。
UnknownParameter 未知参数错误。