UpdateCredentialProvider - 更新凭据提供商

更新时间:
复制为 MD 格式

更新凭据提供商

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

CredentialProviderId

string

凭据提供商 ID。

atp_01kr2cmj5gxxx4fvmls2e93dxxxxx

ClientToken

string

幂等 Token,保证请求幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参考文档《如何保证幂等性》。

client-token-example

CredentialProviderName

string

凭据提供商名称。

说明

长度不能超过 64 个字符。

test_example_name

CredentialProviderConfig

object

凭据提供商配置。

OAuthProviderConfig

object

OAuth 类型的凭据提供商配置。

ClientSecret

string

对应 OAuth 协议中的 client_secret,客户端密钥。

说明

长度不能超过 1024 个字符。

client_secret_example_xxx

TokenEndpoint

string

对应 OAuth 协议的 Token 端点。

说明

必须以http://https://开头,且长度不能超过 1024 个字符。

https://example.com/token

Scope

string

对应 OAuth 协议中的 scope,权限范围。

说明

OAuth 凭据提供商处的 Scope 配置将作为兜底值,若在调用 DeveloperAPI 获取 OAuth Access Token 时不指定 scope 参数,则会以凭据提供商处的 Scope 配置为准进行签发。

重要 多个 Scope 值之间使用空格分隔。若需要置空 Scope 配置,填入空字符串即可。

对单个 Scope 值的限制如下:

  1. 允许的字符:小写英文字母、数字、特殊字符|/:_-.

  2. 且必须包含小写英文字母或数字

  3. 必须以特殊字符.或小写英文字母或数字开头

  4. 长度不超过 1024 个字符

example:test_01 example:test_02

JwtProviderConfig

object

JWT 类型的凭据提供商配置。

Expiration

integer

JWT 的有效时长,单位秒。

900

ExpirationCleanupEnabled

boolean

是否开启 JWT 过期清理。

true

DerivedShortTokenEnabled

boolean

是否开启 JWT 派生短令牌能力。

false

AllowedTokenIssuers

array

允许的 JWT 的 issuer 列表。

说明

列表长度不超过 200。

重要 若需要置空 Issuer 列表,调用时传入空列表或者空字符串

string

允许的 JWT 的 issuer。

说明

长度不超过 1024 个字符。

https://test.issuer.com

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情