文档首页/ 智能体身份/ API参考/ API/ OAuth2凭证提供商/ 查询OAuth2凭证提供商详情
更新时间:2026-11-04 GMT+08:00
分享

查询OAuth2凭证提供商详情

功能介绍

查询OAuth2凭证提供商详情。

URI

GET /v1/oauth2-credential-providers/{credential_provider_name}

表1 路径参数

参数

是否必选

参数类型

描述

credential_provider_name

是

String

参数解释:

凭证提供商名称,用于唯一标识一个凭证提供商。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字及"-"、"_"组成,长度为1~56个字符。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

credential_provider

Oauth2CredentialProvider object

参数解释:

OAuth2凭证提供商,用于配置通过OAuth2协议获取外部服务访问凭证的参数。

取值范围:

不涉及。

表3 Oauth2CredentialProvider

参数

参数类型

描述

credential_provider_id

String

参数解释:

凭证提供商的唯一标识符。

取值范围:

只能由英文字母、数字及"-"、"_"组成,长度为1~64个字符。

name

String

参数解释:

凭证提供商名称,用于唯一标识一个凭证提供商。

取值范围:

只能由英文字母、数字及"-"、"_"组成,长度为1~56个字符。

urn

String

参数解释:

凭证提供商的唯一资源名称(URN)。

取值范围:

只能由英文字母、数字及"/"、"="、"_"、":"、"-"组成,长度为16~1500个字符。

credential_provider_vendor

String

参数解释:

支持的OAuth2提供商类型。

取值范围:

  • MicrosoftOauth2:微软OAuth2

  • GoogleOauth2:谷歌OAuth2

  • GithubOauth2:GitHub OAuth2

  • CustomOauth2:自定义OAuth2

client_secret

Secret object

参数解释:

凭证信息,包含凭证ID和凭证名称。用于API Key授权方式下,标识存储在CSMS(凭证管理服务)中的API密钥凭证。

取值范围:

不涉及。

callback_url

String

参数解释:

OAuth2 提供方认证完成后跳转回调的 URL。

取值范围:

必须以https://开头,长度为1~2048个字符。

created_at

String

参数解释:

UTC时间戳,记录资源的创建或更新时间。

取值范围:

使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2025-01-01T00:00:00Z。

updated_at

String

参数解释:

UTC时间戳,记录资源的创建或更新时间。

取值范围:

使用UTC+0时间格式,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2025-01-01T00:00:00Z。

oauth2_provider_config_output

Oauth2ProviderConfigOutput object

参数解释:

OAuth2提供商配置输出(UNION类型)。

取值范围:

不涉及。

tags

Array of Tag objects

参数解释:

自定义标签列表。

取值范围:

不涉及。

表4 Secret

参数

参数类型

描述

secret_id

String

参数解释:

凭证ID,唯一标识CSMS中的凭证。

取值范围:

只能由英文字母、数字及"-"、"_"组成,长度为1~64个字符。

secret_name

String

参数解释:

凭证名称,CSMS中存储的凭证名称。

取值范围:

只能由英文字母、数字及"-"、"_"组成,长度为1~64个字符。

表5 Oauth2ProviderConfigOutput

参数

参数类型

描述

microsoft_oauth2_provider_config

MicrosoftOauth2ProviderConfigOutput object

参数解释:

Microsoft OAuth2提供商的输出配置。

取值范围:

不涉及。

google_oauth2_provider_config

GoogleOauth2ProviderConfigOutput object

参数解释:

Google OAuth2提供商的输出配置。

取值范围:

不涉及。

github_oauth2_provider_config

GithubOauth2ProviderConfigOutput object

参数解释:

GitHub OAuth2提供商的输出配置。

取值范围:

不涉及。

custom_oauth2_provider_config

CustomOauth2ProviderConfigOutput object

参数解释:

自定义OAuth2提供商的输出配置。

取值范围:

不涉及。

表6 MicrosoftOauth2ProviderConfigOutput

参数

参数类型

描述

oauth2_discovery

Oauth2Discovery object

参数解释:

OAuth2提供商的发现信息(UNION类型)。

取值范围:

不涉及。

client_id

String

参数解释:

OAuth2应用的客户端ID(Client ID),用于标识接入OAuth2认证流程的应用。

取值范围:

长度为1~256个字符。

表7 GoogleOauth2ProviderConfigOutput

参数

参数类型

描述

oauth2_discovery

Oauth2Discovery object

参数解释:

OAuth2提供商的发现信息(UNION类型)。

取值范围:

不涉及。

client_id

String

参数解释:

OAuth2应用的客户端ID(Client ID),用于标识接入OAuth2认证流程的应用。

取值范围:

长度为1~256个字符。

表8 GithubOauth2ProviderConfigOutput

参数

参数类型

描述

oauth2_discovery

Oauth2Discovery object

参数解释:

OAuth2提供商的发现信息(UNION类型)。

取值范围:

不涉及。

client_id

String

参数解释:

OAuth2应用的客户端ID(Client ID),用于标识接入OAuth2认证流程的应用。

取值范围:

长度为1~256个字符。

表9 CustomOauth2ProviderConfigOutput

参数

参数类型

描述

oauth2_discovery

Oauth2Discovery object

参数解释:

OAuth2提供商的发现信息(UNION类型)。

取值范围:

不涉及。

client_id

String

参数解释:

OAuth2应用的客户端ID(Client ID),用于标识接入OAuth2认证流程的应用。

取值范围:

长度为1~256个字符。

表10 Oauth2Discovery

参数

参数类型

描述

discovery_url

String

参数解释:

OpenID Connect发现地址(Discovery URL),用于获取身份提供商的OIDC配置信息,包括签发者地址、JWKS端点等。

取值范围:

必须以https://开头,且以/.well-known/openid-configuration结尾,长度为1~2048个字符。

authorization_server_metadata

Oauth2AuthorizationServerMetadata object

参数解释:

OAuth2提供商的授权服务器元数据。

取值范围:

不涉及。

表11 Oauth2AuthorizationServerMetadata

参数

参数类型

描述

authorization_endpoint

String

参数解释:

授权服务器的授权端点。

取值范围:

必须以https://开头,长度为1~2048个字符。

issuer

String

参数解释:

授权服务器的签发者标识。

取值范围:

必须以https://开头,长度为1~2048个字符。

token_endpoint

String

参数解释:

授权服务器的令牌端点。

取值范围:

必须以https://开头,长度为1~2048个字符。

response_types

Array of strings

参数解释:

支持的响应类型列表。

取值范围:

数组长度范围[1,20],每个元素为1~50个字符的字符串。

token_endpoint_auth_methods

Array of strings

参数解释:

令牌端点支持的客户端认证方法列表。

取值范围:

数组长度范围[1,2]。

表12 Tag

参数

参数类型

描述

key

String

参数解释:

标签键,用于标识标签的名称。

取值范围:

可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"符号的任意组合,长度为1~128个字符。

value

String

参数解释:

标签值,用于标识标签的具体内容。

取值范围:

可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"、"&"符号的任意组合,可以是空字符串,长度为0~255个字符。

状态码:400

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

request_id

String

参数解释:

请求ID。

取值范围:

不涉及。

encoded_authorization_message

String

参数解释:

加密后的认证失败信息,可以通过STS5解密接口进行解密。

取值范围:

不涉及。

状态码:404

表14 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及。

request_id

String

参数解释:

请求ID。

取值范围:

不涉及。

encoded_authorization_message

String

参数解释:

加密后的认证失败信息,可以通过STS5解密接口进行解密。

取值范围:

不涉及。

请求示例

查询OAuth2凭证提供商详情。

GET https://{endpoint}/v1/oauth2-credential-providers/{credential_provider_name}

响应示例

状态码:200

{
  "credential_provider" : {
    "credential_provider_id" : "684a2c3e5f1b9d0e7a3c4f56",
    "name" : "my_microsoft_oauthprovider",
    "urn" : "agentIdentity:<region>:<account-id>:oauth2CredentialProvider:tokenVault/<token-vault-id>/<name>",
    "credential_provider_vendor" : "MicrosoftOauth2",
    "client_secret" : {
      "secret_id" : "285624f5-5958-4f36-b171-168303615bce",
      "secret_name" : "test-secret"
    },
    "callback_url" : "https://agent-identity.cn-north-4.myhuaweicloud.com/v1/oauth2/callback/9c38be75-5973-4709-a211-7e2c438c250d",
    "created_at" : "2025-01-01 00:00:00",
    "updated_at" : "2025-01-01 00:00:00",
    "oauth2_provider_config_output" : {
      "microsoft_oauth2_provider_config" : {
        "oauth2_discovery" : {
          "discovery_url" : "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration",
          "authorization_server_metadata" : null
        },
        "client_id" : "285624f5-5958-4f36-b171-168303615bce"
      },
      "google_oauth2_provider_config" : null,
      "github_oauth2_provider_config" : null,
      "custom_oauth2_provider_config" : null
    }
  }
}

状态码

状态码

描述

200

请求成功。

400

请求体异常。

404

未找到相应的资源。

错误码

请参见错误码。

相关文档