forked from docs/doc-exports
Wei, Hongmin
80f18fd272
Reviewed-by: Kabai, Zoltán Gábor <zoltan-gabor.kabai@t-systems.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
138 lines
9.2 KiB
HTML
138 lines
9.2 KiB
HTML
<a name="iam_08_0018"></a><a name="iam_08_0018"></a>
|
|
|
|
<h1 class="topictitle1">Unbinding a Virtual MFA Device</h1>
|
|
<div id="body1604926565941"><div class="section" id="iam_08_0018__section698451634412"><h4 class="sectiontitle">Function</h4><p id="iam_08_0018__p125131719443">This API is used by the administrator to unbind a virtual MFA device from an IAM user, or used by an IAM user to unbind their own virtual MFA device.</p>
|
|
</div>
|
|
<div class="section" id="iam_08_0018__section1998681664419"><h4 class="sectiontitle">URI</h4><p id="iam_08_0018__p351141774415">PUT /v3.0/OS-MFA/mfa-devices/unbind</p>
|
|
</div>
|
|
<div class="section" id="iam_08_0018__section39875160445"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0018__table17988131611449" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_08_0018__row65141784411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_08_0018__p0513171446">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="iam_08_0018__p852181794414">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="iam_08_0018__p25220171448">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="iam_08_0018__p10524177445">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0018__row175251754412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_08_0018__p452191720448">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_08_0018__p185281754419">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_08_0018__p16521417164411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><ul id="iam_08_0018__ul1948614712363"><li id="iam_08_0018__li1648664763615">Administrator: Provide a token with <strong id="iam_08_0018__b84911454155611">Security Administrator</strong> permissions.</li><li id="iam_08_0018__li10486247173614">User: Provide the token (no special permission requirements) of the user specified in <strong id="iam_08_0018__b133621730174911">user_id</strong> of the request body.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0018__table999581614449" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request body</caption><thead align="left"><tr id="iam_08_0018__row45271784415"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="iam_08_0018__p15217174442">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="iam_08_0018__p652181713444">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="iam_08_0018__p8522017104416">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="iam_08_0018__p105231794417">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0018__row352201794410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="iam_08_0018__p16527172448">user_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="iam_08_0018__p452191717443">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="iam_08_0018__p1952917104419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="iam_08_0018__p252171734418">ID of the user from whom you will unbind the MFA device.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0018__row135281718446"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="iam_08_0018__p652141713443">authentication_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="iam_08_0018__p18521417184416">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="iam_08_0018__p252717174419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><ul id="iam_08_0018__ul1426718376208"><li id="iam_08_0018__li1026716375209">Administrator: Set this parameter to any value, because verification is not required.</li><li id="iam_08_0018__li1624313102217">IAM user: Enter the MFA verification code.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0018__row95211714447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="iam_08_0018__p952171794415">serial_number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="iam_08_0018__p9521217154415">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="iam_08_0018__p115219174441">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="iam_08_0018__p65211714447">Serial number of the MFA device.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_08_0018__section72117164415"><h4 class="sectiontitle">Response Parameters</h4><p id="iam_08_0018__p10521317194418">None</p>
|
|
</div>
|
|
<div class="section" id="iam_08_0018__section162161764418"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_08_0018__screen165281754418">PUT https://sample.domain.com/v3.0/OS-MFA/mfa-devices/unbind
|
|
|
|
{
|
|
"user_id" : "09f99d8f6a001d4f1f01c00c31968...",
|
|
"authentication_code" : "373658",
|
|
"serial_number" : "iam:09f6bd6a96801de40f01c00c85691...:mfa/{device_name}"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="iam_08_0018__section174151715447"><h4 class="sectiontitle">Example Response</h4><p id="iam_08_0018__p9776113915319">None</p>
|
|
</div>
|
|
<div class="section" id="iam_08_0018__section174151734417"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0018__table281471411116" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_08_0018__row284112140110"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="iam_08_0018__p138410141513">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="iam_08_0018__p128413148118">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0018__row138418143110"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0018__p584115142116">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0018__p1084115141615">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0018__row1384119141719"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0018__p158411914210">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0018__p884131417111">The request is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0018__row1261484418539"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0018__p1652019501377">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0018__p552075016378">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0018__row5841191419119"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0018__p684116149115">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0018__p984119141014">You do not have permission to perform this action.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0018__row1584115141619"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0018__p584141413112">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0018__p0841181418112">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0018__row1584191414115"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0018__p158414141015">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0018__p48415141012">A conflict occurs when the requested resource is saved.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0018__row168412142114"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0018__p88419141411">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0018__p1784151411111">A system error occurred.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="iam_02_0020.html">Security Settings</a></div>
|
|
</div>
|
|
</div>
|
|
|