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>
224 lines
18 KiB
HTML
224 lines
18 KiB
HTML
<a name="en-us_topic_0057845644"></a><a name="en-us_topic_0057845644"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Protocol List</h1>
|
|
<div id="body1492676120180"><div class="section" id="en-us_topic_0057845644__section30634034102834"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845644__p555120371208">This API is used to query the protocol list.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845644__section52068019102834"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845644__ul56759983102834"><li id="en-us_topic_0057845644__li41077806102834">URI format<p id="en-us_topic_0057845644__p34155936102834"><a name="en-us_topic_0057845644__li41077806102834"></a><a name="li41077806102834"></a>GET /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845644__ul20799102720237"><li id="en-us_topic_0057845644__li107995274236">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845644__table37148424111357" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845644__row51867099111357"><th align="left" class="cellrowborder" valign="top" width="22.06%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0057845644__p40485495111357"><strong id="en-us_topic_0057845644__a6f95694edbbb43d8a152536754b86c82">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.26%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0057845644__p58099659111357"><strong id="en-us_topic_0057845644__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.73%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0057845644__p8451968111357"><strong id="en-us_topic_0057845644__a703d34a49a2f4162bc1a1a439f655f95_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.95%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0057845644__p13520830111357"><strong id="en-us_topic_0057845644__b842352706114032">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845644__row21445420111357"><td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845644__p59357426111357">idp_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.26%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845644__p43222201111357">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845644__p11337384111357">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.95%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845644__p45912936111357">ID of an identity provider.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845644__section14876957102834"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845644__ul64182900102834"><li id="en-us_topic_0057845644__li40775188102834">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845644__table31432374102834" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845644__row45139814102834"><th align="left" class="cellrowborder" valign="top" width="21.759999999999998%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845644__p32446352102834"><strong id="en-us_topic_0057845644__a3da1b7475f644c07832655d87318eb65">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.47%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845644__p10908883102834"><strong id="en-us_topic_0057845644__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.72%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845644__p11204310102834"><strong id="en-us_topic_0057845644__a703d34a49a2f4162bc1a1a439f655f95_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.05%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845644__p35133889102834"><strong id="en-us_topic_0057845644__b842352706114032_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845644__row27272765102834"><td class="cellrowborder" valign="top" width="21.759999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845644__p61610353102834">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845644__p24382726102834">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.72%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845644__p28843812102834">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.05%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845644__p54647410102834">Fill <strong id="en-us_topic_0057845644__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row22064642102834"><td class="cellrowborder" valign="top" width="21.759999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845644__p42405596102834">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.47%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845644__p12301242102834">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.72%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845644__p56876549102834">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.05%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845644__p43597732102834">Authenticated token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845644__ul4334942594041"><li id="en-us_topic_0057845644__li5460051194041">Example request<pre class="screen" id="en-us_topic_0057845644__screen2956678210321"><em id="en-us_topic_0057845644__i2929347191419">curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://sample.domain.com/v3/OS-FEDERATION/identity_providers/ACME/protocols/</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845644__section41755392102834"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845644__ul26743552102834"><li id="en-us_topic_0057845644__li39365377102834">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845644__table18744076102834" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845644__row63415676102834"><th align="left" class="cellrowborder" valign="top" width="21.772177217721772%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845644__p36396095102834"><strong id="en-us_topic_0057845644__b508006551079">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.241724172417243%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845644__p62402620102834"><strong id="en-us_topic_0057845644__a105e6ed8c3de4c5a9dde97ae5a71071e_5">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.94169416941694%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845644__p21447449102834"><strong id="en-us_topic_0057845644__a703d34a49a2f4162bc1a1a439f655f95_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.04440444044405%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845644__p59521790102834"><strong id="en-us_topic_0057845644__b842352706114032_2">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845644__row56535700102834"><td class="cellrowborder" valign="top" width="21.772177217721772%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845644__p15988994102834">protocols</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.241724172417243%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845644__p20040177102834">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.94169416941694%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845644__p12641673102834">List of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.04440444044405%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845644__p17342577102834">List of protocols.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row21865466102834"><td class="cellrowborder" valign="top" width="21.772177217721772%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845644__p26272350102834">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.241724172417243%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845644__p47685606102834">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.94169416941694%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845644__p37328891102834">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.04440444044405%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845644__p3741316102834">Protocol resource link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845644__li1648144524410">protocols parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845644__table33600724102858" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845644__row58807483102858"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="en-us_topic_0057845644__p65785692102858"><strong id="en-us_topic_0057845644__b37426530113629">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.708229177082295%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="en-us_topic_0057845644__p27040837102858"><strong id="en-us_topic_0057845644__b487382303">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.328267173282672%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="en-us_topic_0057845644__p42824223102858"><strong id="en-us_topic_0057845644__b867956266">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.785621437856214%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="en-us_topic_0057845644__p46210066102858"><strong id="en-us_topic_0057845644__b14438018113629">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845644__row52027845102858"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845644__p53505888102858">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.708229177082295%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845644__p39009676102858">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845644__p5667184102858">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.785621437856214%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845644__p56388789102858">ID of a protocol. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row37737059102858"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845644__p36802972102858">mapping_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.708229177082295%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845644__p28250761102858">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845644__p6610323102858">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.785621437856214%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845644__p65674145102858">Mapping ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row54196397102858"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845644__p27832061102858">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.708229177082295%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845644__p39804486102858">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.328267173282672%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845644__p2937903102858">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.785621437856214%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845644__p36643552102858">Protocol resource link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845644__li9160103192418">Example response<pre class="screen" id="en-us_topic_0057845644__screen52669952111523">{
|
|
"links": {
|
|
"next": null,
|
|
"previous": null,
|
|
"self": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME/protocols"
|
|
},
|
|
"protocols": [
|
|
{
|
|
"id": "saml",
|
|
"links": {
|
|
"identity_provider": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME",
|
|
"self": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME/protocols/saml"
|
|
},
|
|
"mapping_id": "ACME"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845644__section49506819102834"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845644__table50629427102834" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845644__row51403085102834"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845644__p2900329102834"><strong id="en-us_topic_0057845644__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_0057845644__p33600122102834"><strong id="en-us_topic_0057845644__b38470707163018">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845644__row37255400102834"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845644__p64897434102834">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845644__p22200825102834">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row65589700102834"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845644__p11165521102834">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845644__p31991998102834">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row19492528102834"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845644__p35390929102834">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845644__p48092966102834">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row30183511102834"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845644__p28945366102834">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845644__p62873342102834">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row28989168102834"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845644__p66421287102834">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845644__p11415195102834">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row35627895102834"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845644__p178384102834">405</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845644__p14449178102834">The method specified in the request is not allowed for the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row62933745102834"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845644__p64468583102834">413</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845644__p54572705102834">The request entity is too large.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row21392299102834"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845644__p55054663102834">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845644__p30242715102834">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845644__row3748986102834"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845644__p35232470102834">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845644__p35257855102834">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>
|
|
|