doc-exports/docs/iam/api-ref/iam_08_0020.html
Wei, Hongmin 80f18fd272 IAM API 2.6 Version
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>
2023-08-03 03:34:59 +00:00

108 lines
7.1 KiB
HTML

<a name="iam_08_0020"></a><a name="iam_08_0020"></a>
<h1 class="topictitle1">Deleting a Virtual MFA Device</h1>
<div id="body1604926565941"><div class="section" id="iam_08_0020__section13815375453"><h4 class="sectiontitle">Function</h4><p id="iam_08_0020__p125723712456">This API is provided for the administrator to delete their own virtual MFA device.</p>
</div>
<div class="section" id="iam_08_0020__section61113734514"><h4 class="sectiontitle">URI</h4><p id="iam_08_0020__p1657103744519">DELETE /v3.0/OS-MFA/virtual-mfa-devices</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0020__table8115376457" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Query parameters</caption><thead align="left"><tr id="iam_08_0020__row1457113714454"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="iam_08_0020__p35714371453">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="iam_08_0020__p157193712456">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="iam_08_0020__p1457173774515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="iam_08_0020__p157437184511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0020__row8571337194510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_08_0020__p195715371454">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_08_0020__p165793784515">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_08_0020__p9578374455">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_08_0020__p1057113794510">ID of the user whose virtual MFA device is to be deleted, that is, the administrator's user ID.</p>
</td>
</tr>
<tr id="iam_08_0020__row1757173715458"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_08_0020__p15714371459">serial_number</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_08_0020__p2571379452">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_08_0020__p155711375458">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_08_0020__p75716371452">Serial number of the virtual MFA device.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_08_0020__section151913704512"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0020__table1219143713456" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_08_0020__row185719375453"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_08_0020__p1257837144514">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_0020__p10571637154512">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_0020__p17571637204519">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_0020__p165723715459">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0020__row1257837154516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_08_0020__p10579376455">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_0020__p2571137184511">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_08_0020__p85783714514">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_08_0020__p105783714519">Token with <strong id="iam_08_0020__b13819520174512">Security Administrator</strong> permissions.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_08_0020__section2022123774519"><h4 class="sectiontitle">Response Parameters</h4><p id="iam_08_0020__p157937124519">None</p>
</div>
<div class="section" id="iam_08_0020__section5221237124519"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_08_0020__screen257203794519">DELETE https://sample.domain.com/v3.0/OS-MFA/virtual-mfa-devices?user_id=09f6bd85fc801de41f0cc00ce9172...&amp;serial_number=iam:09f6bd6a96801de40f01c00c85691...:mfa/{device_name}</pre>
</div>
<div class="section" id="iam_08_0020__section182311375454"><h4 class="sectiontitle">Example Response</h4><p id="iam_08_0020__p176584010539">None</p>
</div>
<div class="section" id="iam_08_0020__section1724337184510"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0020__table179395257320" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_08_0020__row109795251437"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="iam_08_0020__p19979625432">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_0020__p1397913251130">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0020__row697919251439"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0020__p29791257310">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0020__p097917255318">The request is successful.</p>
</td>
</tr>
<tr id="iam_08_0020__row151684518537"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0020__p1652019501377">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0020__p552075016378">Authentication failed.</p>
</td>
</tr>
<tr id="iam_08_0020__row897932520311"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0020__p159791253316">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0020__p14979122516316">You do not have permission to perform this action.</p>
</td>
</tr>
<tr id="iam_08_0020__row597917251316"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0020__p897919256313">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0020__p179799251734">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>