文档首页/ IAM 身份中心/ API参考/ API/ 身份提供商管理/ 查询外部身份提供商配置
更新时间:2025-08-14 GMT+08:00
分享

查询外部身份提供商配置

功能介绍

查询外部身份提供商配置。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/identity-stores/{identity_store_id}/external-idp

表1 路径参数

参数

是否必选

参数类型

描述

identity_store_id

String

身份源的全局唯一标识符(ID)

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

associations

Array of ExternalIdpConfigurationDto objects

外部身份提供商配置信息

表4 ExternalIdpConfigurationDto

参数

参数类型

描述

idp_certificate_ids

Array of IdpCertificateBody objects

身份提供商证书对应的全局唯一标识符列表

idp_id

String

身份提供商对应的全局唯一标识符(ID)

idp_saml_config

IdpSAMLConfig object

身份提供商配置信息

is_enabled

Boolean

是否启用身份提供商

表5 IdpCertificateBody

参数

参数类型

描述

certificate_id

String

证书全局唯一标识符(ID)

status

String

证书状态

表6 IdpSAMLConfig

参数

参数类型

描述

entity_id

String

身份提供商发布者标识

login_url

String

身份提供商登录链接

want_request_signed

Boolean

是否要求SAML请求签名验证

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

encoded_authorization_message

String

加密的错误信息

请求示例

查询外部身份提供商配置

GET https://{hostname}/v1/identity-stores/{identity_store_id}/external-idp

响应示例

状态码:200

Successful

{
  "associations" : [ {
    "idp_certificate_ids" : [ {
      "certificate_id" : "553523a6-ebde-4570-9409-xxxxxx",
      "status" : "ACTIVE"
    } ],
    "idp_id" : "a48e3f1b-59f8-4b8f-9944-795xxx",
    "idp_saml_config" : {
      "entity_id" : "https://sts.windows.net/36118e7b-55b4-4a70-8d9f-xxxxx/",
      "login_url" : "https://login.microsoftonline.com/36118e7b-55b4-4a70-xxxxxx/saml2",
      "want_request_signed" : false
    },
    "is_enabled" : true
  } ]
}

状态码

状态码

描述

200

Successful

400

Bad request

403

Forbidden

错误码

请参见错误码

相关文档