GetCredentialProvider - 查询凭据提供商详情

更新时间:
复制为 MD 格式

查询凭据提供商详情

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

CredentialProviderId

string

凭据提供商 ID。

atp_01kr2cmj5gxxx4fvmls2e93dxxxxx

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

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

CredentialProvider

object

凭据提供商。

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

CredentialProviderId

string

凭据提供商 ID。

atp_01kr2cmj5gxxx4fvmls2e93dxxxxx

CredentialProviderIdentifier

string

凭据提供商标识。

test_example_identifier

CredentialProviderName

string

凭据提供商名称。

test_example_name

CreateTime

integer

凭据提供商的创建时间,Unix 时间戳,单位毫秒。

1649830225000

UpdateTime

integer

凭据提供商的更新时间,Unix 时间戳,单位毫秒。

1649830225000

Description

string

描述。

This is an example description

CredentialProviderType

string

凭据提供商类型。取值可选范围:

  • oauth:OAuth 凭据提供商

  • jwt:JWT 凭据提供商

oauth

CredentialProviderCreationType

string

凭据提供商创建类型。取值可选范围:

  • system_init:系统创建。

  • user_custom:用户创建。

user_custom

Status

string

凭据提供商状态。取值可选范围:

  • enabled:启用。

  • disabled:禁用。

enabled

CredentialProviderConfig

object

凭据提供商配置。

ProviderCredentialIds

array

凭据提供商的敏感配置对应的凭据 ID 列表。

说明

系统会将凭据提供商的敏感配置信息以“凭据”的形式进行安全存储。

string

敏感配置对应的凭据 ID。

cred_mkv7xxxxd7i4u7zqtzev2mxxxx

OAuthProviderConfig

object

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

ClientId

string

对应 OAuth 协议中的 client_id,客户端 ID。

client_id_example_xxx

TokenEndpoint

string

对应 OAuth 协议的 Token 端点。

https://example.com/token

Scope

string

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

说明

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

重要 多个 Scope 值之间会通过空格分隔。

example:test_01 example:test_02

JwtProviderConfig

object

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

Issuer

string

JWT issuer。

https://test.issuer.com

JwksEndpoint

string

JWKs 端点地址。

https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks

Expiration

integer

JWT 的有效时长,单位秒。

900

ExpirationCleanupEnabled

boolean

是否开启 JWT 过期清理。

true

DerivedShortTokenEnabled

boolean

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

false

AllowedTokenIssuers

array

允许的 JWT 的 issuer 列表。

string

允许的 JWT 的 issuer。

https://test.issuer.com

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "CredentialProvider": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "CredentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx",
    "CredentialProviderIdentifier": "test_example_identifier",
    "CredentialProviderName": "test_example_name",
    "CreateTime": 1649830225000,
    "UpdateTime": 1649830225000,
    "Description": "This is an example description",
    "CredentialProviderType": "oauth",
    "CredentialProviderCreationType": "user_custom",
    "Status": "enabled",
    "CredentialProviderConfig": {
      "ProviderCredentialIds": [
        "cred_mkv7xxxxd7i4u7zqtzev2mxxxx"
      ],
      "OAuthProviderConfig": {
        "ClientId": "client_id_example_xxx",
        "TokenEndpoint": "https://example.com/token",
        "Scope": "example:test_01 example:test_02"
      },
      "JwtProviderConfig": {
        "Issuer": "https://test.issuer.com",
        "JwksEndpoint": "https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks",
        "Expiration": 900,
        "ExpirationCleanupEnabled": true,
        "DerivedShortTokenEnabled": false,
        "AllowedTokenIssuers": [
          "https://test.issuer.com"
        ]
      }
    }
  }
}

错误码

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

变更历史

更多信息,参考变更详情