
# 查询映射列表 - KeystoneListMappings
#### 功能介绍
该接口可以用于查询映射列表。
该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见：[地区和终端节点](https://developer.huaweicloud.com/endpoint?IAM)。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/IAM/doc?api=KeystoneListMappings)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-iam/iam_19_0001.html)。
#### URI
GET /v3/OS-FEDERATION/mappings
#### 请求参数
表1请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                             |
|:---|:---|:---|:---|
| Content-Type | 是    | String | 该字段内容填为"application/json;charset=utf8"。                                                                                        |
| X-Auth-Token | 是    | String | 访问令牌，承载用户的身份、权限等信息。 token所需权限请参见[授权项](https://support.huaweicloud.com/api-iam/iam_19_0001.html)。 |
   
#### 响应参数
表2响应Body参数 
| 参数                                                                              | 参数类型                           | 描述      |
|:---|:---|:---|
| [links]              | Links object                   | 资源链接信息。 |
| [mappings] | Array of MappingResult objects | 映射信息列表。 |
   
 表3links 
| 参数       | 参数类型   | 描述                    |
|:---|:---|:---|
| self     | String | 资源链接地址。               |
| previous | String | 前一邻接资源链接地址，不存在时为null。 |
| next     | String | 后一邻接资源链接地址，不存在时为null。 |
   
 表4mappings 
| 参数                                                                                       | 参数类型             | 描述                 |
|:---|:---|:---|
| id                                                                                       | String           | 映射ID。              |
| [links]        | Object           | 映射的资源链接信息。         |
| [rules] | Array of objects | 将联邦用户映射为本地用户的规则列表。 |
   
 表5mappings.links 
| 参数   | 参数类型   | 描述      |
|:---|:---|:---|
| self | String | 资源链接地址。 |
   
 表6mappings.rules 
| 参数                                                                                                     | 参数类型                        | 描述                                                          |
|:---|:---|:---|
| [local]                                        | Array of RulesLocal objects | 表示联邦用户在本系统中的用户信息。 user:联邦用户在本系统中的用户名称。group:联邦用户在本系统中所属用户组。 |
| [remote] | Array\<Object\>             | 表示联邦用户在IdP中的用户信息。由断言属性及运算符组成的表达式，取值由断言决定。                   |
   
 表7mappings.rules.local 
| 参数                                        | 参数类型         | 描述             |
|:---|:---|:---|
| [user]  | user object  | 联邦用户在本系统中的用户名称 |
| [group] | group object | 联邦用户在本系统中所属用户组 |
   
 表8mappings.rules.local.user 
| 名称   | 类型     | 描述             |
|:---|:---|:---|
| name | String | 联邦用户在本系统中的用户名称 |
   
 表9mappings.rules.local.group 
| 名称   | 类型     | 描述             |
|:---|:---|:---|
| name | String | 联邦用户在本系统中所属用户组 |
   
 表10mappings.rules.remote 
| 参数         | 参数类型             | 描述                                                                                                |
|:---|:---|:---|
| type       | String           | 表示IdP断言（SAML协议）或ID token（OIDC协议）中的属性。                                                             |
| any_one_of | Array of strings | 输入属性值中包含指定值才生效，并返回布尔值，返回值不能用于local块中的占位符。在同一个remote数组元素中，any_one_of与not_any_of互斥，两者至多填写一个，不能同时填写。 |
| not_any_of | Array of strings | 输入属性值中不包含指定值才生效，并返回布尔值，返回值不能用于local块中的占位符。not_any_of与any_one_of互斥，两者至多填写一个，不能同时填写。                |
| regex      | Boolean          | 同级的any_one_of或not_any_of的值是否支持正则表达式，true：支持正则表达式，false：不支持正则表达式。                                  |
   
#### 请求示例
查询映射列表。
```
GET https://iam.myhuaweicloud.com/v3/OS-FEDERATION/mappings
```
#### 响应示例
**状态码为 200 时:**
请求成功。
```
{
    "mappings": [
        {
            "rules": [
                {
                    "local": [
                        {
                            "user": {
                                "name": "LocalUser"
                            }
                        },
                        {
                            "group": {
                                "name": "LocalGroup"
                            }
                        }
                    ],
                    "remote": [
                        {
                            "type": "UserName"
                        },
                        {
                            "type": "orgPersonType",
                            "not_any_of": [
                                "Contractor",
                                "Guest"
                            ]
                        }
                    ]
                }
            ],
            "id": "ACME",
            "links": {
                "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/mappings/ACME"
            }
        }
    ],
    "links": {
        "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/mappings",
        "previous": null,
        "next": null
    }
}
```
#### 返回值
| 返回值 | 描述        |
|:---|:---|
| 200 | 请求成功。     |
| 400 | 参数无效。     |
| 401 | 认证失败。     |
| 403 | 没有操作权限。   |
| 404 | 未找到相应的资源。 |
| 405 | 不允许的方法。   |
| 413 | 请求体过大。    |
| 500 | 内部服务错误。   |
| 503 | 服务不可用。    |
   
#### 错误码
无
