更新时间:2022-03-15 GMT+08:00
分享

注册协议

功能介绍

该接口可以用于管理员创建身份提供商后,将协议关联到某一身份提供商。

该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见:地区和终端节点

调试

您可以在API Explorer中调试该接口。

URI

PUT /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}

表1 路径参数

参数

是否必选

参数类型

描述

idp_id

String

身份提供商名称。

protocol_id

String

待注册的协议ID。该字段内容为“saml”或“oidc”。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

拥有Security Administrator权限的token。

表3 请求Body参数

参数

是否必选

参数类型

描述

protocol

Object

协议信息。

表4 protocol

参数

是否必选

参数类型

描述

mapping_id

String

映射ID。

响应参数

表5 响应Body参数

参数

参数类型

描述

protocol

Object

协议信息。

表6 protocol

参数

参数类型

描述

id

String

协议ID。该字段内容为“saml”或“oidc”。

mapping_id

String

映射ID。

links

Object

协议的资源链接信息。

请求示例

PUT https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}
{
    "protocol": {
        "mapping_id": "ACME"
    }
}

响应示例

状态码为 201 时:

请求成功。

{
    "protocol": {
        "mapping_id": "ACME",
        "id": "saml",
        "links": {
            "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME/protocols/saml",
            "identity_provider": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME"
        }
    }
}

返回值

返回值

描述

201

请求成功。

400

参数无效。

401

认证失败。

403

没有操作权限。

404

未找到相应的资源。

405

不允许的方法。

413

请求体过大。

500

内部服务错误。

503

服务不可用。

错误码

分享:

    相关文档

    相关产品

关闭导读