文档首页/ 统一身份认证服务 IAM/ API参考/ API/ 联邦身份认证管理/ 协议/ 注册协议
更新时间：2024-11-18 GMT+08:00
编辑
查看PDF
分享

注册协议

功能介绍

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

该接口可以使用全局区域的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

访问令牌，承载用户的身份、权限等信息。

token所需权限请参见授权项。
表3 请求Body参数

参数

是否必选

参数类型

描述

protocol

是

Object

协议信息。
表4 protocol

参数

是否必选

参数类型

描述

mapping_id

否

String

映射ID。身份提供商类型为iam_user_sso时，不需要绑定映射ID，无需传入此字段；否则此字段必填。

响应参数

表5 响应Body参数

参数

参数类型

描述

protocol

Object

协议信息。
表6 protocol

参数

参数类型

描述

id

String

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

mapping_id

String

映射ID。

links

Object

协议的资源链接信息。
表7 protocol.links

参数

参数类型

描述

identity_provider

String

身份提供商的资源链接地址。

self

String

资源链接地址。

请求示例

注册协议。

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

服务不可用。

错误码

无

父主题： 协议

相关文档