yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
46d24ba35819bcea8865ffd421f1007aab28dae3
doc-exports/docs/iam/api-ref/en-us_topic_0057845590.html
weihongmin1 46d24ba358 IAM API 0401 Version 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: weihongmin1 <weihongmin1@huawei.com>
Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
2026-01-14 14:13:49 +00:00

648 lines
54 KiB
HTML
Raw Blame History

<a name="en-us_topic_0057845590"></a><a name="en-us_topic_0057845590"></a>
<h1 class="topictitle1">Creating a Mapping</h1>
<div id="body1492680701565"><div class="section" id="en-us_topic_0057845590__section5391497194352"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845590__p15366183172015">This API is used to create a mapping.</p>
</div>
<div class="section" id="en-us_topic_0057845590__section4532847794352"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845590__ul4772801194352"><li id="en-us_topic_0057845590__li2689891994352">URI format<p id="en-us_topic_0057845590__p4076368694352"><a name="en-us_topic_0057845590__li2689891994352"></a><a name="li2689891994352"></a>PUT /v3/OS-FEDERATION/mappings/{id}</p>
</li></ul>
<ul id="en-us_topic_0057845590__ul1352424594352"><li id="en-us_topic_0057845590__li5460934494352">URI parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table2172204994352" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row2412280694352"><th align="left" class="cellrowborder" valign="top" width="20.3020302030203%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0057845590__p779028994352"><strong id="en-us_topic_0057845590__a6f95694edbbb43d8a152536754b86c82">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.32173217321732%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0057845590__p2703368594352"><strong id="en-us_topic_0057845590__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.95179517951795%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0057845590__p4224484094352"><strong id="en-us_topic_0057845590__a703d34a49a2f4162bc1a1a439f655f95_1">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.42444244424442%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0057845590__p6638891794352"><strong id="en-us_topic_0057845590__b842352706114032_1">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row879318694352"><td class="cellrowborder" valign="top" width="20.3020302030203%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845590__p4115944794352">id</p>
</td>
<td class="cellrowborder" valign="top" width="17.32173217321732%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845590__p4558092594352">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.95179517951795%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845590__p106745194352">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.42444244424442%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845590__p1935474694352">Mapping ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845590__section2423062694352"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845590__ul1652367494352"><li id="en-us_topic_0057845590__li1449533994352">Parameters in the request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table6334919494352" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row4195230994352"><th align="left" class="cellrowborder" valign="top" width="20.07%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845590__p4269386794352"><strong id="en-us_topic_0057845590__b1970987591656">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.48%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845590__p3565117394352"><strong id="en-us_topic_0057845590__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.740000000000002%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845590__p206388394352"><strong id="en-us_topic_0057845590__a703d34a49a2f4162bc1a1a439f655f95_3">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.71%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845590__p3295687194352"><strong id="en-us_topic_0057845590__b5626546891656">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row5226086294352"><td class="cellrowborder" valign="top" width="20.07%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845590__p527145094352">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845590__p2433433994352">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.740000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845590__p2492444894352">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.71%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845590__p561442694352">Fill <strong id="en-us_topic_0057845590__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row5052983794352"><td class="cellrowborder" valign="top" width="20.07%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845590__p6638498894352">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845590__p847497294352">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.740000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845590__p1538414994352">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.71%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845590__p24112655143038">Authenticated token with the <strong id="en-us_topic_0057845590__b750798910387">Security Administrator</strong> permission.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li136617369118">Parameters in the request body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table9586164781115" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row259854711111"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.1.1.5.1.1"><p id="en-us_topic_0057845590__p3598134721111"><strong id="en-us_topic_0057845590__b2119053791656">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.1.1.5.1.2"><p id="en-us_topic_0057845590__p10598174714112">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.1.1.5.1.3"><p id="en-us_topic_0057845590__p13598194721116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.1.1.5.1.4"><p id="en-us_topic_0057845590__p10598194716114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row14598547161119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845590__p105981047171111"><a href="#en-us_topic_0057845590__li786441494352">mapping</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845590__p959864731114">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845590__p12598174716110">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845590__p125981847181112">Mapping information.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li786441494352"><a name="en-us_topic_0057845590__li786441494352"></a><a name="li786441494352"></a>mapping
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table367086394352" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row97994794352"><th align="left" class="cellrowborder" valign="top" width="20.16%" id="mcps1.3.3.2.3.1.1.5.1.1"><p id="en-us_topic_0057845590__p1226690694352"><strong id="en-us_topic_0057845590__b1200039253">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.65%" id="mcps1.3.3.2.3.1.1.5.1.2"><p id="en-us_topic_0057845590__p5409532594352"><strong id="en-us_topic_0057845590__a105e6ed8c3de4c5a9dde97ae5a71071e_5">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.53%" id="mcps1.3.3.2.3.1.1.5.1.3"><p id="en-us_topic_0057845590__p1964521394352"><strong id="en-us_topic_0057845590__a703d34a49a2f4162bc1a1a439f655f95_5">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.66%" id="mcps1.3.3.2.3.1.1.5.1.4"><p id="en-us_topic_0057845590__p4775840194352"><strong id="en-us_topic_0057845590__b4224969591656">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row4322526694352"><td class="cellrowborder" valign="top" width="20.16%" headers="mcps1.3.3.2.3.1.1.5.1.1 "><p id="en-us_topic_0057845590__p1158562394352"><a href="#en-us_topic_0057845590__li20832560132">rules</a></p>
</td>
<td class="cellrowborder" valign="top" width="17.65%" headers="mcps1.3.3.2.3.1.1.5.1.2 "><p id="en-us_topic_0057845590__p6602024894352">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.53%" headers="mcps1.3.3.2.3.1.1.5.1.3 "><p id="en-us_topic_0057845590__p1170594394352">Array</p>
</td>
<td class="cellrowborder" valign="top" width="44.66%" headers="mcps1.3.3.2.3.1.1.5.1.4 "><p id="en-us_topic_0057845590__p1814613755019">Rule used to map federated users to local users.</p>
<p id="en-us_topic_0057845590__p2833135010253">Example rule for SAML:</p>
<pre class="screen" id="en-us_topic_0057845590__screen4220213569"> "rules": [
{
"local": [
{
"user": {
"name": "{0}"
}
},
{
"group": {
"name": "0cd5e9"
}
}
],
"remote": [
{
"type": "UserName"
},
{
"type": "orgPersonType",
"not_any_of": [
"Contractor",
"Guest"
]
}
]
}
]</pre>
<p id="en-us_topic_0057845590__p13647153563918"><strong id="en-us_topic_0057845590__b84235270617449">local</strong>: indicates the information about a federated user in the cloud system.</p>
<ul id="en-us_topic_0057845590__ul14819125213392"><li id="en-us_topic_0057845590__li198193521397"><strong id="en-us_topic_0057845590__b2108329775">user</strong>: indicates the name of a federated user in the cloud system. <strong id="en-us_topic_0057845590__b842352706114340">{0}</strong> indicates the first attribute of the user information in <strong id="en-us_topic_0057845590__b842352706114418">remote</strong>.</li><li id="en-us_topic_0057845590__li1819452183919"><strong id="en-us_topic_0057845590__b18367114281414">group</strong>: indicates the user group to which a federated user belongs in the cloud system.</li></ul>
<p id="en-us_topic_0057845590__p281920526391"><strong id="en-us_topic_0057845590__b842352706173126">remote</strong>: indicates the information about a federated user in the IdP. This expression is a combination of assertion attributes and operators. The value of <strong id="en-us_topic_0057845590__b842352706173622">remote</strong> is determined based on the assertion.</p>
<ul id="en-us_topic_0057845590__ul1054319873214"><li id="en-us_topic_0057845590__li209105567716"><strong id="en-us_topic_0057845590__b35911621152914">"type": "UserName" </strong>indicates an attribute in an IdP assertion.</li><li id="en-us_topic_0057845590__li5546168153216"><strong id="en-us_topic_0057845590__b118011252134614">"type": "orgPersonType"</strong> indicates an attribute in an IdP assertion.</li><li id="en-us_topic_0057845590__li0634131152918"><strong id="en-us_topic_0057845590__b125912218157">not_any_of</strong>: The rule is not matched if any of the specified strings appear in the attribute type. The condition result is Boolean, not the argument that is passed as input.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li20832560132"><a name="en-us_topic_0057845590__li20832560132"></a><a name="li20832560132"></a>mapping.rules
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table1141112346128" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row0432143411121"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.4.1.1.5.1.1"><p id="en-us_topic_0057845590__p1433143421215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.4.1.1.5.1.2"><p id="en-us_topic_0057845590__p543315348129">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.4.1.1.5.1.3"><p id="en-us_topic_0057845590__p943383411127">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.4.1.1.5.1.4"><p id="en-us_topic_0057845590__p1433153410122">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row20433634111220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.4.1.1.5.1.1 "><p id="en-us_topic_0057845590__p743363471215"><a href="#en-us_topic_0057845590__li046184451310">local</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.4.1.1.5.1.2 "><p id="en-us_topic_0057845590__p4433334151213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.4.1.1.5.1.3 "><p id="en-us_topic_0057845590__p144331234201213">Array of RulesLocal objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.4.1.1.5.1.4 "><p id="en-us_topic_0057845590__p9433934141217">Federated user information on the cloud platform. <strong id="en-us_topic_0057845590__b98476547624025">user</strong> indicates the name of a federated user, and <strong id="en-us_topic_0057845590__b71993836722554">group</strong> indicates the group which the federated user belongs to.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row1443313344125"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.4.1.1.5.1.1 "><p id="en-us_topic_0057845590__p343373411128"><a href="#en-us_topic_0057845590__li25801914140">remote</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.4.1.1.5.1.2 "><p id="en-us_topic_0057845590__p14331034191213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.4.1.1.5.1.3 "><p id="en-us_topic_0057845590__p8433103411216">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.4.1.1.5.1.4 "><p id="en-us_topic_0057845590__p643323418125">Federated user information in the IdP system. If SAML is used, this parameter is an expression consisting of assertion attributes and operators, and the value of this parameter is determined by the assertion. If OIDC protocol is used, the value of this parameter is determined by the ID token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li046184451310"><a name="en-us_topic_0057845590__li046184451310"></a><a name="li046184451310"></a>mapping.rules.local
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table841216343126" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row543313341122"><th align="left" class="cellrowborder" valign="top" width="18.3%" id="mcps1.3.3.2.5.1.1.5.1.1"><p id="en-us_topic_0057845590__p1043317345126">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.39%" id="mcps1.3.3.2.5.1.1.5.1.2"><p id="en-us_topic_0057845590__p743383414128">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.63%" id="mcps1.3.3.2.5.1.1.5.1.3"><p id="en-us_topic_0057845590__p243323421219">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.67999999999999%" id="mcps1.3.3.2.5.1.1.5.1.4"><p id="en-us_topic_0057845590__p13433173410129">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row543303441216"><td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.3.2.5.1.1.5.1.1 "><p id="en-us_topic_0057845590__p10433134131219"><a href="#en-us_topic_0057845590__li1751645716138">user</a></p>
</td>
<td class="cellrowborder" valign="top" width="11.39%" headers="mcps1.3.3.2.5.1.1.5.1.2 "><p id="en-us_topic_0057845590__p1443393421218">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.63%" headers="mcps1.3.3.2.5.1.1.5.1.3 "><p id="en-us_topic_0057845590__p174336346120">user object</p>
</td>
<td class="cellrowborder" valign="top" width="55.67999999999999%" headers="mcps1.3.3.2.5.1.1.5.1.4 "><p id="en-us_topic_0057845590__p1243320347123">Name of a federated user on the cloud platform.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row1843320340122"><td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.3.2.5.1.1.5.1.1 "><p id="en-us_topic_0057845590__p54331934121219"><a href="#en-us_topic_0057845590__li88102921415">group</a></p>
</td>
<td class="cellrowborder" valign="top" width="11.39%" headers="mcps1.3.3.2.5.1.1.5.1.2 "><p id="en-us_topic_0057845590__p174337340127">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.63%" headers="mcps1.3.3.2.5.1.1.5.1.3 "><p id="en-us_topic_0057845590__p543383481210">group object</p>
</td>
<td class="cellrowborder" valign="top" width="55.67999999999999%" headers="mcps1.3.3.2.5.1.1.5.1.4 "><p id="en-us_topic_0057845590__p114331534151210">User group to which a federated user belongs on the cloud platform.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li1751645716138"><a name="en-us_topic_0057845590__li1751645716138"></a><a name="li1751645716138"></a>mapping.rules.local.user
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table20413634101215" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row13433113451213"><th align="left" class="cellrowborder" valign="top" width="18.04%" id="mcps1.3.3.2.6.1.1.5.1.1"><p id="en-us_topic_0057845590__p343313414124">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.3.3.2.6.1.1.5.1.2"><p id="en-us_topic_0057845590__p1443313421219">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.32%" id="mcps1.3.3.2.6.1.1.5.1.3"><p id="en-us_topic_0057845590__p743316342122"><strong id="en-us_topic_0057845590__b177541172410651">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.120000000000005%" id="mcps1.3.3.2.6.1.1.5.1.4"><p id="en-us_topic_0057845590__p19433113412127">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row8433163414123"><td class="cellrowborder" valign="top" width="18.04%" headers="mcps1.3.3.2.6.1.1.5.1.1 "><p id="en-us_topic_0057845590__p643373412121">name</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.3.2.6.1.1.5.1.2 "><p id="en-us_topic_0057845590__p154338345127">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.32%" headers="mcps1.3.3.2.6.1.1.5.1.3 "><p id="en-us_topic_0057845590__p104331834191216">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.120000000000005%" headers="mcps1.3.3.2.6.1.1.5.1.4 "><p id="en-us_topic_0057845590__p1433234161214">Name of a federated user on the cloud platform.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li88102921415"><a name="en-us_topic_0057845590__li88102921415"></a><a name="li88102921415"></a>mapping.rules.local.group
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table4413934141216" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row343353412128"><th align="left" class="cellrowborder" valign="top" width="18.04%" id="mcps1.3.3.2.7.1.1.5.1.1"><p id="en-us_topic_0057845590__p12433734111217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.3.3.2.7.1.1.5.1.2"><p id="en-us_topic_0057845590__p20433153421220">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.09%" id="mcps1.3.3.2.7.1.1.5.1.3"><p id="en-us_topic_0057845590__p543333419125"><strong id="en-us_topic_0057845590__b89687874810651">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.35%" id="mcps1.3.3.2.7.1.1.5.1.4"><p id="en-us_topic_0057845590__p14433153415126">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row943314347122"><td class="cellrowborder" valign="top" width="18.04%" headers="mcps1.3.3.2.7.1.1.5.1.1 "><p id="en-us_topic_0057845590__p94331334201216">name</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.3.2.7.1.1.5.1.2 "><p id="en-us_topic_0057845590__p19433534191215">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.09%" headers="mcps1.3.3.2.7.1.1.5.1.3 "><p id="en-us_topic_0057845590__p13433173416122">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.35%" headers="mcps1.3.3.2.7.1.1.5.1.4 "><p id="en-us_topic_0057845590__p343314341122">User group to which a federated user belongs on the cloud platform.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li25801914140"><a name="en-us_topic_0057845590__li25801914140"></a><a name="li25801914140"></a>mapping.rules.remote
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table20414203461211" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row1243393410122"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.8.1.1.5.1.1"><p id="en-us_topic_0057845590__p0433143471213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.8.1.1.5.1.2"><p id="en-us_topic_0057845590__p204331734101215">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.8.1.1.5.1.3"><p id="en-us_topic_0057845590__p243373415123">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.8.1.1.5.1.4"><p id="en-us_topic_0057845590__p24339348127">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row1043333411210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.8.1.1.5.1.1 "><p id="en-us_topic_0057845590__p543312341123">type</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.8.1.1.5.1.2 "><p id="en-us_topic_0057845590__p1043363413122">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.8.1.1.5.1.3 "><p id="en-us_topic_0057845590__p543343416126">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.8.1.1.5.1.4 "><p id="en-us_topic_0057845590__p1043333481220">IdP assertion (SAML) or ID token (OIDC)</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row24331934121211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.8.1.1.5.1.1 "><p id="en-us_topic_0057845590__p17433193416124">any_one_of</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.8.1.1.5.1.2 "><p id="en-us_topic_0057845590__p343373411216">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.8.1.1.5.1.3 "><p id="en-us_topic_0057845590__p1243314345128">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.8.1.1.5.1.4 "><p id="en-us_topic_0057845590__p743383411217">The rule is matched only if the specified strings appear in the attribute type. A Boolean value will be returned and cannot be used as a placeholder in the local block. In a <strong id="en-us_topic_0057845590__b143675272471">remote</strong> array, <strong id="en-us_topic_0057845590__b5367727194713">any_one_of</strong> and <strong id="en-us_topic_0057845590__b936782719473">not_any_of</strong> are mutually exclusive and cannot be used at the same time.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row1343313418124"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.8.1.1.5.1.1 "><p id="en-us_topic_0057845590__p2043320342128">not_any_of</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.8.1.1.5.1.2 "><p id="en-us_topic_0057845590__p943393412121">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.8.1.1.5.1.3 "><p id="en-us_topic_0057845590__p14331534101218">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.8.1.1.5.1.4 "><p id="en-us_topic_0057845590__p17433534121212">The rule is matched only if the specified strings do not appear in the attribute type. A Boolean value will be returned and cannot be used as a placeholder in the local block. <strong id="en-us_topic_0057845590__b168207559823949">any_one_of</strong> and <strong id="en-us_topic_0057845590__b194861551823949">not_any_of</strong> are mutually exclusive and cannot be used at the same time.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0057845590__ul3015356794352"><li id="en-us_topic_0057845590__li294665294352">Example request<pre class="screen" id="en-us_topic_0057845590__screen15531796204529"><em id="en-us_topic_0057845590__i10948418226">curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X PUT -d'{"mapping":{"rules":[{"local":[{"user":{"name":"{0}"}},{"group":{"name":"0cd5e9"}}],"remote":[{"type":"UserName"},{"type":"orgPersonType","not_any_of":["Contractor","Guest"]}]}]}}' https://sample.domain.com/v3/OS-FEDERATION/mappings/ACME</em></pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845590__section1540149194352"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845590__ul183102912396"><li id="en-us_topic_0057845590__li1993810581378">Parameters in the response body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table1593845823716" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row1193812586371"><th align="left" class="cellrowborder" valign="top" width="20.080000000000002%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845590__p159381358163711"><strong id="en-us_topic_0057845590__b7788032112155">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.87%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845590__p11938165814372"><strong id="en-us_topic_0057845590__b1994232157">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.47%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845590__p7938058143715"><strong id="en-us_topic_0057845590__b692613818">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.58%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845590__p693817586374">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row18938135814374"><td class="cellrowborder" valign="top" width="20.080000000000002%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845590__p1349952864016"><a href="#en-us_topic_0057845590__li2050666394352">mapping</a></p>
</td>
<td class="cellrowborder" valign="top" width="17.87%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845590__p1293812585377">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845590__p11934633144015">Object</p>
</td>
<td class="cellrowborder" valign="top" width="44.58%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845590__p1846717381406">Mapping information.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0057845590__ul3956122094352"><li id="en-us_topic_0057845590__li2050666394352"><a name="en-us_topic_0057845590__li2050666394352"></a><a name="li2050666394352"></a>mapping
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table5034224694352" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row751467994352"><th align="left" class="cellrowborder" valign="top" width="20.080000000000002%" id="mcps1.3.4.3.1.1.1.5.1.1"><p id="en-us_topic_0057845590__p470925894352"><strong id="en-us_topic_0057845590__b155475057">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.87%" id="mcps1.3.4.3.1.1.1.5.1.2"><p id="en-us_topic_0057845590__p4590562694352"><strong id="en-us_topic_0057845590__a105e6ed8c3de4c5a9dde97ae5a71071e_7">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.47%" id="mcps1.3.4.3.1.1.1.5.1.3"><p id="en-us_topic_0057845590__p2736820694352"><strong id="en-us_topic_0057845590__a703d34a49a2f4162bc1a1a439f655f95_7">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.58%" id="mcps1.3.4.3.1.1.1.5.1.4"><p id="en-us_topic_0057845590__p223220794352"><strong id="en-us_topic_0057845590__b842352706114032_3">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row4659104494352"><td class="cellrowborder" valign="top" width="20.080000000000002%" headers="mcps1.3.4.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845590__p1577819794352">id</p>
</td>
<td class="cellrowborder" valign="top" width="17.87%" headers="mcps1.3.4.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845590__p296561294352">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.4.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845590__p3888798294352">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.58%" headers="mcps1.3.4.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845590__p6291885394352">Mapping ID.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row2939877294352"><td class="cellrowborder" valign="top" width="20.080000000000002%" headers="mcps1.3.4.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845590__p3249034194352"><a href="#en-us_topic_0057845590__li5349142112384">rules</a></p>
</td>
<td class="cellrowborder" valign="top" width="17.87%" headers="mcps1.3.4.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845590__p1447196694352">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.4.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845590__p1397223994352">Array of MappingRules objects</p>
</td>
<td class="cellrowborder" valign="top" width="44.58%" headers="mcps1.3.4.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845590__p1840244814552">Rule used to map federated users to local users.</p>
<p id="en-us_topic_0057845590__p1040224811557">Example rule for SAML:</p>
<pre class="screen" id="en-us_topic_0057845590__screen19402144865519"> "rules": [
{
"local": [
{
"user": {
"name": "{0}"
}
},
{
"group": {
"name": "0cd5e9"
}
}
],
"remote": [
{
"type": "UserName"
},
{
"type": "orgPersonType",
"not_any_of": [
"Contractor",
"Guest"
]
}
]
}
]</pre>
<p id="en-us_topic_0057845590__p164022048175519"><strong id="en-us_topic_0057845590__b20828194011516">local</strong>: indicates the information about a federated user in the cloud system.</p>
<ul id="en-us_topic_0057845590__ul1402448185510"><li id="en-us_topic_0057845590__li18402144825512"><strong id="en-us_topic_0057845590__b7635442161511">user</strong>: indicates the name of a federated user in the cloud system. <strong id="en-us_topic_0057845590__b16154194319158">{0}</strong> indicates the first attribute of the user information in <strong id="en-us_topic_0057845590__b1155194331510">remote</strong>.</li><li id="en-us_topic_0057845590__li1540210481557"><strong id="en-us_topic_0057845590__b897913436151">group</strong>: indicates the user group to which a federated user belongs in the cloud system.</li></ul>
<p id="en-us_topic_0057845590__p2402174895516"><strong id="en-us_topic_0057845590__b119194519154">remote</strong>: indicates the information about a federated user in the IdP. This expression is a combination of assertion attributes and operators. The value of <strong id="en-us_topic_0057845590__b31911445111519">remote</strong> is determined based on the assertion.</p>
<ul id="en-us_topic_0057845590__ul16402114815518"><li id="en-us_topic_0057845590__li14028485556"><strong id="en-us_topic_0057845590__b1591010458150">"type": "UserName" </strong>indicates an attribute in an IdP assertion.</li><li id="en-us_topic_0057845590__li4402648175516"><strong id="en-us_topic_0057845590__b149575464152">"type": "orgPersonType"</strong> indicates an attribute in an IdP assertion.</li><li id="en-us_topic_0057845590__li5402104814559"><strong id="en-us_topic_0057845590__b16352647111514">not_any_of</strong>: The rule is not matched if any of the specified strings appear in the attribute type. The condition result is Boolean, not the argument that is passed as input.</li></ul>
</td>
</tr>
<tr id="en-us_topic_0057845590__row5232411094352"><td class="cellrowborder" valign="top" width="20.080000000000002%" headers="mcps1.3.4.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845590__p1039448994352"><a href="#en-us_topic_0057845590__li10346182114385">links</a></p>
</td>
<td class="cellrowborder" valign="top" width="17.87%" headers="mcps1.3.4.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845590__p3664728594352">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.4.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845590__p1564010594352">Object</p>
</td>
<td class="cellrowborder" valign="top" width="44.58%" headers="mcps1.3.4.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845590__p5888902294352">Mapping resource link.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li10346182114385"><div class="p" id="en-us_topic_0057845590__p202371843124110"><a name="en-us_topic_0057845590__li10346182114385"></a><a name="li10346182114385"></a>mapping.links
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table81361312162112" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row14136201212116"><th align="left" class="cellrowborder" valign="top" width="19.400000000000002%" id="mcps1.3.4.3.2.1.1.1.4.1.1"><p id="en-us_topic_0057845590__p111361012172112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.119999999999997%" id="mcps1.3.4.3.2.1.1.1.4.1.2"><p id="en-us_topic_0057845590__p18136181210215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.480000000000004%" id="mcps1.3.4.3.2.1.1.1.4.1.3"><p id="en-us_topic_0057845590__p6136181216213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row13136612202115"><td class="cellrowborder" valign="top" width="19.400000000000002%" headers="mcps1.3.4.3.2.1.1.1.4.1.1 "><p id="en-us_topic_0057845590__p513671211215">self</p>
</td>
<td class="cellrowborder" valign="top" width="20.119999999999997%" headers="mcps1.3.4.3.2.1.1.1.4.1.2 "><p id="en-us_topic_0057845590__p1013631232112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.480000000000004%" headers="mcps1.3.4.3.2.1.1.1.4.1.3 "><p id="en-us_topic_0057845590__p31368129215">Resource link.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</li><li id="en-us_topic_0057845590__li5349142112384"><a name="en-us_topic_0057845590__li5349142112384"></a><a name="li5349142112384"></a>mapping.rules
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__en-us_topic_0224276973_response_Rs1331MappingsArritemRulesArritem" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__en-us_topic_0224276973_row19310114884517"><th align="left" class="cellrowborder" valign="top" width="19.400000000000002%" id="mcps1.3.4.3.3.1.1.4.1.1"><p id="en-us_topic_0057845590__en-us_topic_0224276973_p733535213195">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.119999999999997%" id="mcps1.3.4.3.3.1.1.4.1.2"><p id="en-us_topic_0057845590__en-us_topic_0224276973_p1433575214193">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.480000000000004%" id="mcps1.3.4.3.3.1.1.4.1.3"><p id="en-us_topic_0057845590__en-us_topic_0224276973_p13335115281918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__en-us_topic_0224276973_row14310174811456"><td class="cellrowborder" valign="top" width="19.400000000000002%" headers="mcps1.3.4.3.3.1.1.4.1.1 "><p id="en-us_topic_0057845590__en-us_topic_0224276973_p10336652131917"><a href="#en-us_topic_0057845590__li15896123417387">local</a></p>
</td>
<td class="cellrowborder" valign="top" width="20.119999999999997%" headers="mcps1.3.4.3.3.1.1.4.1.2 "><p id="en-us_topic_0057845590__p791014313326">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.480000000000004%" headers="mcps1.3.4.3.3.1.1.4.1.3 "><p id="en-us_topic_0057845590__en-us_topic_0224276973_p1933620525197">Federated user information on the cloud platform. <strong id="en-us_topic_0057845590__b161233278484">user</strong> indicates the name of a federated user, and <strong id="en-us_topic_0057845590__b15704162834812">group</strong> indicates the user group to which a federated user belongs in the cloud system.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__en-us_topic_0224276973_row931044854519"><td class="cellrowborder" valign="top" width="19.400000000000002%" headers="mcps1.3.4.3.3.1.1.4.1.1 "><p id="en-us_topic_0057845590__en-us_topic_0224276973_p43360522191"><a href="#en-us_topic_0057845590__li34018391387">remote</a></p>
</td>
<td class="cellrowborder" valign="top" width="20.119999999999997%" headers="mcps1.3.4.3.3.1.1.4.1.2 "><p id="en-us_topic_0057845590__p98099221322">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60.480000000000004%" headers="mcps1.3.4.3.3.1.1.4.1.3 "><p id="en-us_topic_0057845590__en-us_topic_0224276973_p153362520196">Federated user information in the IdP system. If SAML is used, this parameter is an expression consisting of assertion attributes and operators, and the value of this parameter is determined by the assertion. If OIDC protocol is used, the value of this parameter is determined by the ID token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li15896123417387"><a name="en-us_topic_0057845590__li15896123417387"></a><a name="li15896123417387"></a>mapping.rules.local
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__en-us_topic_0224276973_table137153246203" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__en-us_topic_0224276973_row1716122413204"><th align="left" class="cellrowborder" valign="top" width="19.48%" id="mcps1.3.4.3.4.1.1.4.1.1"><p id="en-us_topic_0057845590__en-us_topic_0224276973_p18716024172012">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.4.1.1.4.1.2"><p id="en-us_topic_0057845590__en-us_topic_0224276973_p18716142482013">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.519999999999996%" id="mcps1.3.4.3.4.1.1.4.1.3"><p id="en-us_topic_0057845590__en-us_topic_0224276973_p47168248206">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row205831883263"><td class="cellrowborder" valign="top" width="19.48%" headers="mcps1.3.4.3.4.1.1.4.1.1 "><p id="en-us_topic_0057845590__p125837810268"><a href="#en-us_topic_0057845590__li1319043817387">user</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.4.1.1.4.1.2 "><p id="en-us_topic_0057845590__p8583081260">user object</p>
</td>
<td class="cellrowborder" valign="top" width="60.519999999999996%" headers="mcps1.3.4.3.4.1.1.4.1.3 "><p id="en-us_topic_0057845590__p0583148102618">Name of a federated user on the cloud platform.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row185832819264"><td class="cellrowborder" valign="top" width="19.48%" headers="mcps1.3.4.3.4.1.1.4.1.1 "><p id="en-us_topic_0057845590__p185831786268"><a href="#en-us_topic_0057845590__li8617123883812">group</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.4.1.1.4.1.2 "><p id="en-us_topic_0057845590__p3583128102619">group object</p>
</td>
<td class="cellrowborder" valign="top" width="60.519999999999996%" headers="mcps1.3.4.3.4.1.1.4.1.3 "><p id="en-us_topic_0057845590__p16583128182613">User group to which a federated user belongs on the cloud platform.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li1319043817387"><a name="en-us_topic_0057845590__li1319043817387"></a><a name="li1319043817387"></a>mapping.rules.local.user
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table155837862615" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row3583168182615"><th align="left" class="cellrowborder" valign="top" width="19.51195119511951%" id="mcps1.3.4.3.5.1.1.4.1.1"><p id="en-us_topic_0057845590__p195838862611">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.811981198119813%" id="mcps1.3.4.3.5.1.1.4.1.2"><p id="en-us_topic_0057845590__p1858318814264"><strong id="en-us_topic_0057845590__b211888060810651">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.676067606760675%" id="mcps1.3.4.3.5.1.1.4.1.3"><p id="en-us_topic_0057845590__p15831983267">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row558311882616"><td class="cellrowborder" valign="top" width="19.51195119511951%" headers="mcps1.3.4.3.5.1.1.4.1.1 "><p id="en-us_topic_0057845590__p5583484263">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.811981198119813%" headers="mcps1.3.4.3.5.1.1.4.1.2 "><p id="en-us_topic_0057845590__p658313816264">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.676067606760675%" headers="mcps1.3.4.3.5.1.1.4.1.3 "><p id="en-us_topic_0057845590__p8583128102613">Name of a federated user on the cloud platform.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li8617123883812"><a name="en-us_topic_0057845590__li8617123883812"></a><a name="li8617123883812"></a>mapping.rules.local.group
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table175837810263" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row1458348162612"><th align="left" class="cellrowborder" valign="top" width="19.51195119511951%" id="mcps1.3.4.3.6.1.1.4.1.1"><p id="en-us_topic_0057845590__p125832814260">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.561956195619562%" id="mcps1.3.4.3.6.1.1.4.1.2"><p id="en-us_topic_0057845590__p17583158132616"><strong id="en-us_topic_0057845590__b82262596510651">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.92609260926092%" id="mcps1.3.4.3.6.1.1.4.1.3"><p id="en-us_topic_0057845590__p195837819261">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row1258314862615"><td class="cellrowborder" valign="top" width="19.51195119511951%" headers="mcps1.3.4.3.6.1.1.4.1.1 "><p id="en-us_topic_0057845590__p1758310862617">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.561956195619562%" headers="mcps1.3.4.3.6.1.1.4.1.2 "><p id="en-us_topic_0057845590__p158311822614">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.92609260926092%" headers="mcps1.3.4.3.6.1.1.4.1.3 "><p id="en-us_topic_0057845590__p205837832614">User group to which a federated user belongs on the cloud platform.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li34018391387"><a name="en-us_topic_0057845590__li34018391387"></a><a name="li34018391387"></a>mapping.rules.remote
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__en-us_topic_0224276976_response_Rs1331MappingsArritemRulesArritemRemoteArritem" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__en-us_topic_0224276976_row6334144815452"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.7.1.1.4.1.1"><p id="en-us_topic_0057845590__en-us_topic_0224276976_p153351348164514">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.7.1.1.4.1.2"><p id="en-us_topic_0057845590__en-us_topic_0224276976_p17336648184515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.7.1.1.4.1.3"><p id="en-us_topic_0057845590__en-us_topic_0224276976_p11338048154512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__en-us_topic_0224276976_row03341448124518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.7.1.1.4.1.1 "><p id="en-us_topic_0057845590__en-us_topic_0224276976_p2338184812452">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.7.1.1.4.1.2 "><p id="en-us_topic_0057845590__en-us_topic_0224276976_p233984814453">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.7.1.1.4.1.3 "><p id="en-us_topic_0057845590__p53079229214">IdP assertion (SAML) or ID token (OIDC)</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__en-us_topic_0224276976_row9335348174512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.7.1.1.4.1.1 "><p id="en-us_topic_0057845590__en-us_topic_0224276976_p234154818454">any_one_of</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.7.1.1.4.1.2 "><p id="en-us_topic_0057845590__en-us_topic_0224276976_p7342348144515">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.7.1.1.4.1.3 "><p id="en-us_topic_0057845590__en-us_topic_0224276976_p11342204818457">The rule is matched only if the specified strings appear in the attribute type. A Boolean value will be returned and cannot be used as a placeholder in the local block. In a <strong id="en-us_topic_0057845590__b6758363823919">remote</strong> array, <strong id="en-us_topic_0057845590__b153382478623919">any_one_of</strong> and <strong id="en-us_topic_0057845590__b61744566723919">not_any_of</strong> are mutually exclusive and cannot be used at the same time.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__en-us_topic_0224276976_row1233524811457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.7.1.1.4.1.1 "><p id="en-us_topic_0057845590__en-us_topic_0224276976_p1334318486459">not_any_of</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.7.1.1.4.1.2 "><p id="en-us_topic_0057845590__en-us_topic_0224276976_p6343144812459">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.7.1.1.4.1.3 "><p id="en-us_topic_0057845590__en-us_topic_0224276976_p034334815453">The rule is matched only if the specified strings do not appear in the attribute type. A Boolean value will be returned and cannot be used as a placeholder in the local block. <strong id="en-us_topic_0057845590__b128638042723949">any_one_of</strong> and <strong id="en-us_topic_0057845590__b207493653023949">not_any_of</strong> are mutually exclusive and cannot be set at the same time.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845590__li57501239172118">Example response<pre class="screen" id="en-us_topic_0057845590__screen43431241104936">{
"mapping": {
"id": "ACME",
"links": {
"self": "https://example.com/v3/OS-FEDERATION/mappings/ACME"
},
"rules": [
{
"local": [
{
"user": {
"name": "{0}"
}
},
{
"group": {
"name": "0cd5e9"
}
}
],
"remote": [
{
"type": "UserName"
},
{
"type": "orgPersonType",
"not_any_of": [
"Contractor",
"Guest"
]
}
]
}
]
}
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845590__section4195895394352"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845590__table4323206594352" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845590__row5614613494352"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845590__p5154300694352"><strong id="en-us_topic_0057845590__b37151362163018">Status Code</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.2"><p id="en-us_topic_0057845590__p1423397194352"><strong id="en-us_topic_0057845590__b38470707163018">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845590__row1210098894352"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845590__p4065597094352">201</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845590__p479924494352">The request is successful.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row4319319894352"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845590__p898815494352">400</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845590__p5695187094352">The server failed to process the request.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row4280478994352"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845590__p4463590594352">401</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845590__p5873858694352">Authentication failed.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row5888523194352"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845590__p497437394352">403</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845590__p27106894352">Access denied.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row243961594352"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845590__p6339113094352">404</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845590__p3440788194352">The requested resource cannot be found.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row4123547694352"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845590__p5173922994352">405</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845590__p3012798294352">The method specified in the request is not allowed for the requested resource.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row20445144495312"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845590__p1244574417533">409</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845590__p0447174455316">A resource conflict occurs.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row271638594352"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845590__p1870065894352">413</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845590__p3835836894352">The request entity is too large.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row968099794352"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845590__p4596330594352">500</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845590__p3204018894352">Internal server error.</p>
</td>
</tr>
<tr id="en-us_topic_0057845590__row1992624494352"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845590__p341307694352">503</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845590__p802372094352">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845588.html">Mapping</a></div>
</div>
</div>
View Git Blame Copy Permalink