forked from docs/doc-exports
zhangyue
3b5a58b1fe
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
113 lines
9.8 KiB
HTML
113 lines
9.8 KiB
HTML
<a name="en-us_topic_0057845566"></a><a name="en-us_topic_0057845566"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a User Group</h1>
|
|
<div id="body1492670576095"><div class="section" id="en-us_topic_0057845566__section495175389414"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845566__p119651931370">This API is used to delete a user group.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845566__section3019338085013"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845566__en-us_topic_0032920307_ul52733512"><li id="en-us_topic_0057845566__en-us_topic_0032920307_li4839561">URI format<p id="en-us_topic_0057845566__en-us_topic_0032920307_p43556055"><a name="en-us_topic_0057845566__en-us_topic_0032920307_li4839561"></a><a name="en-us_topic_0032920307_li4839561"></a>DELETE /v3/groups/{group_id}</p>
|
|
</li><li id="en-us_topic_0057845566__li1205595994225">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845566__en-us_topic_0032920307_table36168141" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845566__en-us_topic_0032920307_row15662289"><th align="left" class="cellrowborder" valign="top" width="19.36%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="en-us_topic_0057845566__en-us_topic_0032920307_p60685926"><strong id="en-us_topic_0057845566__b842352706111956">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.24%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="en-us_topic_0057845566__en-us_topic_0032920307_p16612996"><strong id="en-us_topic_0057845566__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.18%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="en-us_topic_0057845566__en-us_topic_0032920307_p3475410"><strong id="en-us_topic_0057845566__b842352706143526_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.22%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="en-us_topic_0057845566__en-us_topic_0032920307_p13072760"><strong id="en-us_topic_0057845566__b20601766145329_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845566__en-us_topic_0032920307_row52260639"><td class="cellrowborder" valign="top" width="19.36%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p5253358">group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p22868878">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.18%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p40439847">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.22%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p54402144">ID of a user group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845566__section1437107585444"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845566__ul3118448103456"><li id="en-us_topic_0057845566__li46500394103456">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845566__en-us_topic_0032920307_table21736211" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845566__en-us_topic_0032920307_row48433347"><th align="left" class="cellrowborder" valign="top" width="19.49%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845566__en-us_topic_0032920307_p30787047"><strong id="en-us_topic_0057845566__a173ae121cc9e48328ca613e72f2a1504">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.86%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845566__en-us_topic_0032920307_p10722842"><strong id="en-us_topic_0057845566__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.299999999999997%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845566__en-us_topic_0032920307_p63243911"><strong id="en-us_topic_0057845566__b842352706143526_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.35%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845566__en-us_topic_0032920307_p22483156"><strong id="en-us_topic_0057845566__b20601766145329_3">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845566__en-us_topic_0032920307_row9196329"><td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p6705199">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.86%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p6250253">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.299999999999997%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p36508524">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.35%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p4400500">Fill <strong id="en-us_topic_0057845566__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845566__en-us_topic_0032920307_row39604502"><td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p53848109">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.86%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p66729601">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.299999999999997%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p36388601">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.35%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845566__p2879645811658">Authenticated token with the <strong id="en-us_topic_0057845566__b750798910387">Security Administrator</strong> permission.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845566__ul1240652195217"><li id="en-us_topic_0057845566__li112406527521">Example request<pre class="screen" id="en-us_topic_0057845566__screen92401852145213"><em id="en-us_topic_0057845566__i1124014526527">curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X DELETE https://sample.domain.com/v3/groups/aaec2abd4eba430fbf61541ffde76650</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845566__section33010231119"><h4 class="sectiontitle">Response Parameters</h4><p id="en-us_topic_0057845566__p19301162121119">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845566__section5556784894735"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845566__en-us_topic_0032920307_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845566__en-us_topic_0032920307_row10578662"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845566__en-us_topic_0032920307_p51565323"><strong id="en-us_topic_0057845566__b3845352173228">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_0057845566__en-us_topic_0032920307_p16041657"><strong id="en-us_topic_0057845566__b20601766145329_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845566__en-us_topic_0032920307_row24305815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p22613965">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p19791876">The user group is deleted successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845566__en-us_topic_0032920307_row43909159"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p66980994">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p56751409">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845566__row460808479497"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845566__p120744399497">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845566__p385055099497">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845566__en-us_topic_0032920307_row41000636"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p32717189">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845566__en-us_topic_0032920307_p32846614">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845566__row2569718985351"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845566__p2994811485351">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845566__p987817085351">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845641.html">User Group Management</a></div>
|
|
</div>
|
|
</div>
|
|
|