GetExternalSAMLIdentityProvider - 获取外部SAML身份提供商信息--云身份中心-火山引擎

文档中心

导航

GetExternalSAMLIdentityProvider - 获取外部SAML身份提供商信息

最近更新时间：2025.03.21 11:14:42首次发布时间：2025.03.21 11:14:42

获取云身份中心中已经配置的外部SAML身份提供商信息。

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetExternalSAMLIdentityProvider	要执行的操作，取值：GetExternalSAMLIdentityProvider。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
EntityId	String	entityId	实体 ID
EncodedMetadataDocument	String	base64(saml metadata)	元数据（Base64编码）
CreatedTime	String	2024-07-22T21:53:54+08:00	创建时间
UpdatedTime	String	2024-07-22T21:53:54+08:00	更新时间
IdpCertificates	Array of Object	[ { "ID": "J4X1", "NotAfter": "7" } ]	证书信息

请求示例

POST /?Action=GetExternalSAMLIdentityProvider&Version=2023-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250310T114714Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250310/cn-beijing/cloudidentity/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250310194721011174003105949E1C",
    "Action": "GetExternalSAMLIdentityProvider",
    "Version": "2023-01-01",
    "Service": "cloudidentity",
    "Region": "cn-beijing"
  },
  "Result": {
    "EntityId": "NtmPf",
    "EncodedMetadataDocument": "tPFdtc5Z",
    "CreatedTime": "n",
    "UpdatedTime": "6v",
    "IdpCertificates": [
      {
        "ID": "e20rp8tY",
        "NotAfter": "zZq6V"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ExternalIdpSAMLConfigNotExist	External saml idp config not exist	身份提供商 SAML 配置不存在
500	InternalError	Unknown internal error: %v	服务内部错误