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>
134 lines
11 KiB
HTML
134 lines
11 KiB
HTML
<a name="en-us_topic_0057845570"></a><a name="en-us_topic_0057845570"></a>
|
|
|
|
<h1 class="topictitle1">Deleting an Identity Provider</h1>
|
|
<div id="body1492676120170"><div class="section" id="en-us_topic_0057845570__section6240520694241"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845570__p18428444168">This API is used to delete a SAML or OpenID Connect identity provider.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845570__section6069442994241"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845570__ul1730173194241"><li id="en-us_topic_0057845570__li2149785694241">URI format<p id="en-us_topic_0057845570__p5926297794241"><a name="en-us_topic_0057845570__li2149785694241"></a><a name="li2149785694241"></a>DELETE /v3/OS-FEDERATION/identity_providers/{id}</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845570__ul6360475394241"><li id="en-us_topic_0057845570__li3557187294241">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845570__table5171140094241" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845570__row1006611394241"><th align="left" class="cellrowborder" valign="top" width="19.958004199580042%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0057845570__p1004882694241"><strong id="en-us_topic_0057845570__a6f95694edbbb43d8a152536754b86c82">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.098190180981902%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0057845570__p864861294241"><strong id="en-us_topic_0057845570__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.2982701729827%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0057845570__p2944899994241"><strong id="en-us_topic_0057845570__a703d34a49a2f4162bc1a1a439f655f95_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.645535446455355%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0057845570__p3655869894241"><strong id="en-us_topic_0057845570__b842352706114032">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845570__row846453394241"><td class="cellrowborder" valign="top" width="19.958004199580042%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845570__p1453857794241">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.098190180981902%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845570__p3677408594241">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.2982701729827%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845570__p2591093894241">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.645535446455355%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845570__p1841125694241">ID of an identity provider.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845570__section1491674294241"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845570__ul29655694241"><li id="en-us_topic_0057845570__li266900894241">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845570__table2402107594241" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845570__row605976494241"><th align="left" class="cellrowborder" valign="top" width="19.79%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845570__p2107883694241"><strong id="en-us_topic_0057845570__b2383801391651">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.97%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845570__p2966412894241"><strong id="en-us_topic_0057845570__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.78%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845570__p5398419394241"><strong id="en-us_topic_0057845570__a703d34a49a2f4162bc1a1a439f655f95_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.46%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845570__p1064355194241"><strong id="en-us_topic_0057845570__b433235991651">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845570__row5682131394241"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845570__p3912366494241">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.97%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845570__p1490021194241">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.78%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845570__p6606645194241">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.46%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845570__p4978229594241">Fill <strong id="en-us_topic_0057845570__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845570__row4538747494241"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845570__p5250679294241">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.97%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845570__p2519176694241">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.78%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845570__p2726720594241">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.46%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845570__p44909934142634">Authenticated token with the <strong id="en-us_topic_0057845570__b750798910387">Security Administrator</strong> permission.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845570__ul4334942594041"><li id="en-us_topic_0057845570__li5460051194041">Example request<pre class="screen" id="en-us_topic_0057845570__screen2956678210321"><em id="en-us_topic_0057845570__i136011546132417">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/OS-FEDERATION/identity_providers/ACME</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845570__section8554205141216"><h4 class="sectiontitle">Response Parameters</h4><p id="en-us_topic_0057845570__p1655415517123">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845570__section5501530194241"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845570__table2705437394241" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845570__row719985594241"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845570__p4631736894241"><strong id="en-us_topic_0057845570__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_0057845570__p6071932694241"><strong id="en-us_topic_0057845570__b38470707163018">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845570__row1931834494241"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845570__p2128201494241">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845570__p4612161094241">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845570__row1244130694241"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845570__p111289594241">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845570__p2303569394241">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845570__row599464694241"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845570__p1580432394241">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845570__p508180594241">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845570__row4573624894241"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845570__p1364859994241">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845570__p3179475994241">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845570__row1771738194241"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845570__p2582174594241">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845570__p1118656194241">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845570__row3357018694241"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845570__p3483054094241">405</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845570__p270147894241">The method specified in the request is not allowed for the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845570__row2431330894241"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845570__p2322094294241">413</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845570__p184817394241">The request entity is too large.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845570__row1663356094241"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845570__p514115794241">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845570__p1378056294241">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845570__row5691619694241"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845570__p4680915794241">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845570__p3344533894241">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_0057845605.html">Identity Provider</a></div>
|
|
</div>
|
|
</div>
|
|
|