vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/iam/api-ref/en-us_topic_0057845559.html
zhangyue 3b5a58b1fe IAM API 2.0.38 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2022-10-26 04:31:24 +00:00

143 lines
11 KiB
HTML
Raw Blame History

<a name="en-us_topic_0057845559"></a><a name="en-us_topic_0057845559"></a>
<h1 class="topictitle1">Deleting a Protocol</h1>
<div id="body1492676120184"><div class="section" id="en-us_topic_0057845559__section1360442210300"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845559__p59356331214">This API is used to delete the information about a protocol.</p>
</div>
<div class="section" id="en-us_topic_0057845559__section5262093810300"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845559__ul3443762410300"><li id="en-us_topic_0057845559__li4150316510300">URI format<p id="en-us_topic_0057845559__p3798417010300"><a name="en-us_topic_0057845559__li4150316510300"></a><a name="li4150316510300"></a>DELETE /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}</p>
</li></ul>
<ul id="en-us_topic_0057845559__ul631321710300"><li id="en-us_topic_0057845559__li5681895310300">URI parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845559__table3893247610300" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845559__row2523850510300"><th align="left" class="cellrowborder" valign="top" width="21.15%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0057845559__p3105303110300"><strong id="en-us_topic_0057845559__a6f95694edbbb43d8a152536754b86c82">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.83%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0057845559__p3226762210300"><strong id="en-us_topic_0057845559__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.77%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0057845559__p6354062210300"><strong id="en-us_topic_0057845559__a703d34a49a2f4162bc1a1a439f655f95_1">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.25%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0057845559__p4651674210300"><strong id="en-us_topic_0057845559__b842352706114032">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845559__row975973410300"><td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845559__p5234099910300">idp_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.83%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845559__p1176252810300">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.77%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845559__p1324074610300">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.25%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845559__p6586753310300">ID of an identity provider.</p>
</td>
</tr>
<tr id="en-us_topic_0057845559__row5593688710300"><td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845559__p3459396910300">protocol _id</p>
</td>
<td class="cellrowborder" valign="top" width="17.83%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845559__p5064808710300">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.77%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845559__p885441910300">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.25%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845559__p4611930610300">ID of a protocol. </p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845559__section4467632610300"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845559__ul6201268710300"><li id="en-us_topic_0057845559__li2124327610300">Parameters in the request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845559__table5697175610300" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845559__row1328480810300"><th align="left" class="cellrowborder" valign="top" width="20.97209720972097%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845559__p232768110300"><strong id="en-us_topic_0057845559__b1902707391713">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.99179917991799%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845559__p5432444210300"><strong id="en-us_topic_0057845559__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.92169216921692%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845559__p3820364310300"><strong id="en-us_topic_0057845559__a703d34a49a2f4162bc1a1a439f655f95_3">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.114411441144114%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845559__p748737310300"><strong id="en-us_topic_0057845559__b569276191713">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845559__row249746310300"><td class="cellrowborder" valign="top" width="20.97209720972097%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845559__p96797010300">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="17.99179917991799%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845559__p1129675810300">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.92169216921692%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845559__p4262216910300">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.114411441144114%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845559__p2984370210300">Fill <strong id="en-us_topic_0057845559__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
</td>
</tr>
<tr id="en-us_topic_0057845559__row15786510300"><td class="cellrowborder" valign="top" width="20.97209720972097%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845559__p1278708510300">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="17.99179917991799%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845559__p2912095810300">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.92169216921692%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845559__p998736310300">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.114411441144114%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845559__p41791925143832">Authenticated token with the <strong id="en-us_topic_0057845559__b750798910387">Security Administrator</strong> permission.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0057845559__ul4334942594041"><li id="en-us_topic_0057845559__li5460051194041">Example request<pre class="screen" id="en-us_topic_0057845559__screen2956678210321"><em id="en-us_topic_0057845559__i64193811300">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/protocols/saml</em></pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845559__section246253135018"><h4 class="sectiontitle">Response Parameters</h4><p id="en-us_topic_0057845559__p74621315501">None</p>
</div>
<div class="section" id="en-us_topic_0057845559__section2883882710300"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845559__table5424361310300" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845559__row5928375610300"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845559__p3725493310300"><strong id="en-us_topic_0057845559__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_0057845559__p6485963110300"><strong id="en-us_topic_0057845559__b38470707163018">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845559__row1913878610300"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845559__p673781310300">204</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845559__p889195210300">The request is successful.</p>
</td>
</tr>
<tr id="en-us_topic_0057845559__row1291870810300"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845559__p3978246410300">400</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845559__p115411910300">The server failed to process the request.</p>
</td>
</tr>
<tr id="en-us_topic_0057845559__row1038707710300"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845559__p3604693110300">401</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845559__p3412027310300">Authentication failed.</p>
</td>
</tr>
<tr id="en-us_topic_0057845559__row3864700110300"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845559__p4339939510300">403</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845559__p2569009710300">Access denied.</p>
</td>
</tr>
<tr id="en-us_topic_0057845559__row2988428510300"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845559__p470804510300">404</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845559__p4580738210300">The requested resource cannot be found.</p>
</td>
</tr>
<tr id="en-us_topic_0057845559__row961325510300"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845559__p4047615110300">405</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845559__p5734277110300">The method specified in the request is not allowed for the requested resource.</p>
</td>
</tr>
<tr id="en-us_topic_0057845559__row4632289810300"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845559__p6116724410300">413</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845559__p5559975110300">The request entity is too large.</p>
</td>
</tr>
<tr id="en-us_topic_0057845559__row3063571610300"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845559__p6557395510300">500</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845559__p989013410300">Internal server error.</p>
</td>
</tr>
<tr id="en-us_topic_0057845559__row2190234710300"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845559__p2925967210300">503</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845559__p2122321310300">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_0057845619.html">Protocol</a></div>
</div>
</div>
View Git Blame Copy Permalink