导入Metadata文件
功能介绍
该接口可以用于管理员导入Metadata文件。
账号在使用联邦认证功能前,需要先将Metadata文件导入到IAM中。Metadata文件是SAML 2.0协议约定的接口文件,包含访问接口地址和证书信息,请找企业管理员获取企业IdP的Metadata文件。
该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见:地区和终端节点。
调试
您可以在API Explorer中调试该接口。
URI
POST /v3-ext/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}/metadata
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        idp_id  | 
      
        是  | 
      
        String  | 
      
        身份提供商名称。  | 
     
| 
        protocol_id  | 
      
        是  | 
      
        String  | 
      
        协议ID。  | 
     
请求参数
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        Content-Type  | 
      
        是  | 
      
        String  | 
      
        该字段内容填为“application/json;charset=utf8”。  | 
     
| 
        X-Auth-Token  | 
      
        是  | 
      
        String  | 
      
        访问令牌,承载用户的身份、权限等信息。 token所需权限请参见授权项。  | 
     
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        domain_id  | 
      
        是  | 
      
        String  | 
      
        用户所属账号ID。  | 
     
| 
        xaccount_type  | 
      
        是  | 
      
        String  | 
      
        该字段为标识租户来源字段,默认为空。  | 
     
| 
        metadata  | 
      
        是  | 
      
        String  | 
      
        该字段为用户IdP服务器的Metadata文件的内容。  | 
     
响应参数
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        message  | 
      
        String  | 
      
        导入结果信息。  | 
     
请求示例
导入Metadata文件。
POST https://iam.myhuaweicloud.com/v3-ext/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}/metadata
  {
    "xaccount_type": "",
    "domain_id": "d78cbac186b744899480f25bd...",
    "metadata": "<md:EntityDescript..."
}
 响应示例
状态码为 201 时:
导入成功。
{
    "message": "Import metadata successful"
}
 返回值
| 
        返回值  | 
      
        描述  | 
     
|---|---|
| 
        201  | 
      
        导入成功。  | 
     
| 
        400  | 
      
        参数无效。  | 
     
| 
        401  | 
      
        认证失败。  | 
     
| 
        403  | 
      
        没有操作权限。  | 
     
| 
        500  | 
      
        内部服务错误。  | 
     
错误码
无