文档首页> 统一身份认证服务 IAM> API参考> API> 联邦身份认证管理> 身份提供商> 查询身份提供商详情
更新时间：2023-07-05 GMT+08:00
查看PDF

查询身份提供商详情

功能介绍

该接口可以用于查询身份提供商详情。

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

URI

GET /v3/OS-FEDERATION/identity_providers/{id}

表1 路径参数

参数

是否必选

参数类型

描述

id

是

String

待查询的身份提供商ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

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

X-Auth-Token

是

String

IAM用户的token（无需特殊权限）。

响应参数

表3 响应Body参数

参数

参数类型

描述

identity_provider

Object

身份提供商信息。
表4 identity_provider

参数

参数类型

描述

sso_type

string

身份提供商类型。当前支持如下两种：

  • virtual_user_sso：联邦登录跳转后映射为虚拟用户。
  • iam_user_sso：联邦登录跳转后映射为实际存在的IAM用户。

默认配置为virtual_user_sso类型。

id

String

身份提供商ID。

description

String

身份提供商描述信息。

enabled

Boolean

身份提供商是否启用，true为启用，false为停用，默认为false。

remote_ids

Array of strings

身份提供商的联邦用户ID列表。

links

Object

身份提供商的资源链接信息。
表5 identity_provider.links

参数

参数类型

描述

self

String

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

protocols

String

协议的资源链接地址。

请求示例

查询身份提供商详情。

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

响应示例

状态码为 200 时:

请求成功。

{
    "identity_provider": {
        "remote_ids": [],
        "enabled": true,
        "id": "ACME",
        "sso_type": "iam_user_sso",
        "links": {
            "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME",
            "protocols": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME/protocols"
        },
        "description": "Stores ACME identities."
    }
}

返回值

返回值

描述

200

请求成功。

400

参数无效。

401

认证失败。

403

没有操作权限。

404

未找到相应的资源。

405

不允许的方法。

413

请求体过大。

500

内部服务错误。

503

服务不可用。

错误码

无

父主题： 身份提供商