注册映射
调试
您可以在API Explorer中调试该接口。
URI
PUT /v3/OS-FEDERATION/mappings/{id}
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
id |
是 |
String |
待注册的映射ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
Content-Type |
是 |
String |
该字段内容填为“application/json;charset=utf8”。 |
X-Auth-Token |
是 |
String |
请参见授权项。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
是 |
Object |
映射信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
是 |
Array<Map<String,Object>> |
表示联邦用户在本系统中的用户信息。 user：联邦用户在本系统中的用户名称。group：联邦用户在本系统中所属用户组。 |
|
是 |
Array of objects |
表示联邦用户在IdP中的用户信息。使用SAML协议时，由断言属性及运算符组成的表达式，取值由断言决定。使用OIDC协议时，取值由ID token决定。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
name |
否 |
String |
user：联邦用户在本系统中的用户名称。 "user":{"name":"LocalUser"}
group：联邦用户在本系统中所属用户组。 "group":{"name":"LocalGroup"}
说明：
用户名、用户组名能包含大小写字母、空格、数字或特殊字符（-_.）且不能以数字开头。不能包含”、\"、\\、\n、\r等特殊字符。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
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互斥，两者至多填写一个，不能同时填写。 |
响应参数
参数 |
参数类型 |
描述 |
|---|---|---|
Object |
映射信息。 |
参数 |
参数类型 |
描述 |
|---|---|---|
Array<Map<String,Object>> |
表示联邦用户在本系统中的用户信息。 user：联邦用户在本系统中的用户名称。group：联邦用户在本系统中所属用户组。 |
|
Array<Object> |
表示联邦用户在IdP中的用户信息。使用SAML协议时，由断言属性及运算符组成的表达式，取值由断言决定。使用OIDC协议时，取值由ID token决定。 |
参数 |
参数类型 |
描述 |
|---|---|---|
name |
String |
user：联邦用户在本系统中的用户名称。 "user":{"name":"LocalUser"}
group：联邦用户在本系统中所属用户组。 "group":{"name":"LocalGroup"}
|
参数 |
参数类型 |
描述 |
|---|---|---|
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互斥，两者至多填写一个，不能同时填写。 |
请求示例
PUT https://iam.myhuaweicloud.com/v3/OS-FEDERATION/mappings/{id}
{
"mapping": {
"rules": [
{
"local": [
{
"user": {
"name": "LocalUser"
}
},
{
"group": {
"name": "LocalGroup"
}
}
],
"remote": [
{
"type": "UserName"
},
{
"type": "orgPersonType",
"not_any_of": [
"Contractor",
"Guest"
]
}
]
}
]
}
}
响应示例
状态码为 201 时:
创建成功。
{
"mapping": {
"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"
}
}
}
返回值
返回值 |
描述 |
|---|---|
201 |
创建成功。 |
400 |
参数无效。 |
401 |
认证失败。 |
403 |
没有操作权限。 |
404 |
未找到相应的资源。 |
405 |
不允许的方法。 |
409 |
资源冲突。 |
413 |
请求体过大。 |
500 |
内部服务错误。 |
503 |
服务不可用。 |
错误码
无
