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

查询协议列表

功能介绍

该接口可以用于查询协议列表。

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

调试

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

URI

GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols

表1 路径参数

参数

是否必选

参数类型

描述

idp_id

是

String

身份提供商ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

该字段内容填为“application/json;charset=utf8”。

X-Auth-Token

是

String

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

token所需权限请参见授权项。

响应参数

表3 响应Body参数

参数

参数类型

描述

links

Object

资源链接信息。

protocols

Array of objects

协议信息列表。
表4 links

参数

参数类型

描述

self

String

资源链接地址。

previous

String

前一邻接资源链接地址，不存在时为null。

next

String

后一邻接资源链接地址，不存在时为null。
表5 protocols

参数

参数类型

描述

id

String

协议ID。

mapping_id

String

映射ID。

links

Object

协议的资源链接信息。
表6 protocols.links

参数

参数类型

描述

identity_provider

String

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

self

String

资源链接地址。

请求示例

查询协议列表。

GET https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/{idp_id}/protocols

响应示例

状态码为 200 时:

请求成功。

{
    "links": {
        "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/protocols",
        "previous": null,
        "next": null
    },
    "protocols": [
        {
            "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"
            }
        }
    ]
}

返回值

返回值

描述

200

请求成功。

400

参数无效。

401

认证失败。

403

没有操作权限。

404

未找到相应的资源。

405

不允许的方法。

413

请求体过大。

500

内部服务错误。

503

服务不可用。

错误码

无

父主题： 协议

相关文档