forked from docs/doc-exports
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
122 lines
11 KiB
HTML
122 lines
11 KiB
HTML
<a name="iam_03_0005"></a><a name="iam_03_0005"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Permanent Access Key</h1>
|
|
<div id="body8662426"><div class="section" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_section16481621183614"><h4 class="sectiontitle">Function</h4><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p14649152111366">This API can be used by the administrator to delete the specified permanent access key of an IAM user or used by an IAM user to delete one of their permanent access keys.</p>
|
|
<p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p136490210362">The API can be called using both the global endpoint and region-specific endpoints.</p>
|
|
</div>
|
|
<div class="section" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_section564913212369"><h4 class="sectiontitle">URI</h4><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p146501021143620">DELETE /v3.0/OS-CREDENTIAL/credentials/{access_key}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_table17651521153619" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row86501214366"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p12651121173612">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.2.3.2.5.1.2"><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p166521213367">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p13652132115365">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.3.2.5.1.4"><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p1465202173613">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row2650721143620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p565316211364">access_key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p1765313219367">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p19654132114361">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p4654162120361">AK to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_section36540217360"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row206551212367"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p1465632113369">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p18656321173619">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.5.1.3"><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p18656112115365">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.5.1.4"><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p865732123616">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row1265552115367"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p965712118369">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p15658112111366">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p665852193618">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p765882114361">Fill <strong id="iam_03_0005__en-us_topic_0221566840_b1743122682519">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row1655122123612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p1965902183615">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p86591421193616">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p3660122183610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p366062118365">A token with <strong id="iam_03_0005__b1065214915218">Security Administrator</strong> permissions is required if the administrator is requesting to delete a specified permanent access key of an IAM user.</p>
|
|
<p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p186601218365">The user token (no special permission requirements) of an IAM user is required if the user is requesting to delete one of their permanent access keys.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_section11661621133616"><h4 class="sectiontitle">Response Parameters</h4><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p36612021113619">None</p>
|
|
</div>
|
|
<div class="section" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_section16613210362"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_screen14662142133616">DELETE https://sample.domain.com/v3.0/OS-CREDENTIAL/credentials/{access_key}</pre>
|
|
</div>
|
|
<div class="section" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_section1666342123619"><h4 class="sectiontitle">Example Response</h4><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p146641021143619">None</p>
|
|
</div>
|
|
<div class="section" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_section0664721123620"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_table2425" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row1466482113613"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p1466582112369">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_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p36651621113613">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row1466412183610"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p206661121203613">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p666620215365">The access key is deleted successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row10664122111368"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p11667182143612">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p366782153610">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row6665142113366"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p16667172193616">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p066872153612">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row17665821153613"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p146681321193620">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p56692021113613">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row2665142111361"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p666914217361">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p267032153620">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_row966592119367"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p12670102153616">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p167092123620">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_section17671152110362"><h4 class="sectiontitle">Error Codes</h4><p id="iam_03_0005__en-us_topic_0221566840_en-us_topic_0221482438_p126711821183613">None</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0097942776.html">Access Key Management</a></div>
|
|
</div>
|
|
</div>
|
|
|