forked from docs/doc-exports
Wei, Hongmin
80f18fd272
Reviewed-by: Kabai, Zoltán Gábor <zoltan-gabor.kabai@t-systems.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
306 lines
26 KiB
HTML
306 lines
26 KiB
HTML
<a name="en-us_topic_0057845612"></a><a name="en-us_topic_0057845612"></a>
|
|
|
|
<h1 class="topictitle1">Updating a SAML Identity Provider</h1>
|
|
<div id="body1492676120169"><div class="section" id="en-us_topic_0057845612__section1512030794223"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845612__p128831532191611">This API is used to update the information about a SAML identity provider.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845612__section1685016594223"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845612__ul2268611594223"><li id="en-us_topic_0057845612__li284844794223">URI format<p id="en-us_topic_0057845612__p2563603094223"><a name="en-us_topic_0057845612__li284844794223"></a><a name="li284844794223"></a>PATCH /v3/OS-FEDERATION/identity_providers/{id}</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845612__ul2939767994223"><li id="en-us_topic_0057845612__li6325252594223">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845612__table3240181694223" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845612__row3355874294223"><th align="left" class="cellrowborder" valign="top" width="20.349999999999998%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0057845612__p3390362094223"><strong id="en-us_topic_0057845612__a6f95694edbbb43d8a152536754b86c82">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.43%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0057845612__p6183871094223"><strong id="en-us_topic_0057845612__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.62%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0057845612__p4287963794223"><strong id="en-us_topic_0057845612__a703d34a49a2f4162bc1a1a439f655f95_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.6%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0057845612__p5069856894223"><strong id="en-us_topic_0057845612__b842352706114032_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845612__row1294335294223"><td class="cellrowborder" valign="top" width="20.349999999999998%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845612__p4177857294223">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.43%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845612__p2862116594223">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845612__p3661299494223">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.6%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845612__p1286251594223">ID of an identity provider.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845612__section3523082694223"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845612__ul3512462094223"><li id="en-us_topic_0057845612__li4768613094223">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845612__table2652198794223" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845612__row4043995894223"><th align="left" class="cellrowborder" valign="top" width="20.380000000000003%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845612__p5441119394223"><strong id="en-us_topic_0057845612__b4787572491644">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.24%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845612__p4523049294223"><strong id="en-us_topic_0057845612__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.560000000000002%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845612__p3979120794223"><strong id="en-us_topic_0057845612__a703d34a49a2f4162bc1a1a439f655f95_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.82%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845612__p186233994223"><strong id="en-us_topic_0057845612__b6054797791644">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845612__row1663176794223"><td class="cellrowborder" valign="top" width="20.380000000000003%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845612__p499591694223">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845612__p201607494223">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.560000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845612__p2908428094223">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845612__p701644694223">Fill <strong id="en-us_topic_0057845612__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__row6314801894223"><td class="cellrowborder" valign="top" width="20.380000000000003%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845612__p1471582494223">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845612__p5113109994223">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.560000000000002%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845612__p4797833094223">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845612__p48307879142519">Authenticated token with the <strong id="en-us_topic_0057845612__b750798910387">Security Administrator</strong> permission.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845612__li1248467894223">Parameters in the request body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845612__en-us_topic_0224276933_requestParameter" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the request body</caption><thead align="left"><tr id="en-us_topic_0057845612__en-us_topic_0224276933_row10743114604511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.1.2.5.1.1"><p id="en-us_topic_0057845612__en-us_topic_0224276933_p374464684514"><strong id="en-us_topic_0057845612__b1442102466">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.1.2.5.1.2"><p id="en-us_topic_0057845612__en-us_topic_0224276933_p774474616453"><strong id="en-us_topic_0057845612__b1036667776">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.1.2.5.1.3"><p id="en-us_topic_0057845612__en-us_topic_0224276933_p187451546114515">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.1.2.5.1.4"><p id="en-us_topic_0057845612__en-us_topic_0224276933_p137451646114510">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845612__en-us_topic_0224276933_row1574314644510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.2.5.1.1 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p11745446104512"><a href="#en-us_topic_0057845612__en-us_topic_0224276933_request_Rq1323Identityprovider">identity_provider</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.1.2.5.1.2 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p674544664512">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.2.5.1.3 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p12746446104520">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.1.2.5.1.4 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p574624624518">Identity provider information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0057845612__en-us_topic_0224276933_request_Rq1323Identityprovider"></a><a name="en-us_topic_0224276933_request_Rq1323Identityprovider"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845612__en-us_topic_0224276933_request_Rq1323Identityprovider" frame="border" border="1" rules="all"><caption><b>Table 2 </b>identity_provider</caption><thead align="left"><tr id="en-us_topic_0057845612__en-us_topic_0224276933_row374634616456"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.2.2.5.1.1"><p id="en-us_topic_0057845612__en-us_topic_0224276933_p1174784613456"><strong id="en-us_topic_0057845612__b333796922">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.2.2.5.1.2"><p id="en-us_topic_0057845612__en-us_topic_0224276933_p77471246174512"><strong id="en-us_topic_0057845612__b1873448282">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.2.2.5.1.3"><p id="en-us_topic_0057845612__en-us_topic_0224276933_p574844614512">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.2.2.5.1.4"><p id="en-us_topic_0057845612__en-us_topic_0224276933_p8748246154514">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845612__en-us_topic_0224276933_row9746164634511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p3748046144511">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p14748184604515">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p19748746154518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p18749154634516">Description of the identity provider.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__en-us_topic_0224276933_row207466467457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p8749746174515">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p274964664517">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p274910466450">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="en-us_topic_0057845612__en-us_topic_0224276933_p275024616452">Whether an identity provider is enabled. <strong id="en-us_topic_0057845612__b1858918312517">true</strong> indicates that the identity provider is enabled. <strong id="en-us_topic_0057845612__b165896332512">false</strong> indicates that the identity provider is disabled. The default value is <strong id="en-us_topic_0057845612__b758917317254">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845612__ul1432466694223"><li id="en-us_topic_0057845612__li6181313494223">Example request<pre class="screen" id="en-us_topic_0057845612__screen24300187203914"><em id="en-us_topic_0057845612__i4238144418237">curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X PATCH -d'{"identity_provider":{"enabled":false}}' https://sample.domain.com/v3/OS-FEDERATION/identity_providers/ACME</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845612__section5700954894223"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845612__ul5437064394223"><li id="en-us_topic_0057845612__li1957374594223">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845612__en-us_topic_0224276697_responseParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response body</caption><thead align="left"><tr id="en-us_topic_0057845612__en-us_topic_0224276697_row1854754624512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0057845612__en-us_topic_0224276697_p1854820469451"><strong id="en-us_topic_0057845612__b984316575">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0057845612__en-us_topic_0224276697_p1554814462455">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0057845612__en-us_topic_0224276697_p954824654513">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845612__en-us_topic_0224276697_row5547446204513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p195497463454"><a href="#en-us_topic_0057845612__en-us_topic_0224276697_response_Rs1321IdentityprovidersArritem">identity_provider</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p17549546124519">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p165491446134519">Identity provider information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0057845612__en-us_topic_0224276697_response_Rs1321IdentityprovidersArritem"></a><a name="en-us_topic_0224276697_response_Rs1321IdentityprovidersArritem"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845612__en-us_topic_0224276697_response_Rs1321IdentityprovidersArritem" frame="border" border="1" rules="all"><caption><b>Table 4 </b>identity_provider</caption><thead align="left"><tr id="en-us_topic_0057845612__en-us_topic_0224276697_row13551194674518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0057845612__en-us_topic_0224276697_p1855212466451"><strong id="en-us_topic_0057845612__b1979344255">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0057845612__en-us_topic_0224276697_p1855317461453">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0057845612__en-us_topic_0224276697_p18554144624513">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845612__row1585415505378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845612__p14291856203710">sso_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0057845612__p43753415376">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0057845612__p1937574113715">Identity provider type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__en-us_topic_0224276697_row1055113468457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p14555154615457">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p1255614612459">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p15561146154517">Identity provider ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__en-us_topic_0224276697_row1055184616451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p15571146124512">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p1955824674513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p255964634520">Description of the identity provider.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__en-us_topic_0224276697_row14551146154520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p15605462453">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p10560184684510">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p12560124654514">Whether an identity provider is enabled. <strong id="en-us_topic_0057845612__b194816387702325">true</strong> indicates that the identity provider is enabled. <strong id="en-us_topic_0057845612__b84332453202325">false</strong> indicates that the identity provider is disabled. The default value is <strong id="en-us_topic_0057845612__b8466722502325">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__en-us_topic_0224276697_row6551946124516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p19560846104514">remote_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p185600467455">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p75611346164519">Federated user ID list of an identity provider.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__en-us_topic_0224276697_row19551446114516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p1256194664518"><a href="#en-us_topic_0057845612__en-us_topic_0224276697_response_Rs1321IdentityprovidersArritemLinks">links</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p115611146134515">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p1856194616459">Identity provider resource link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0057845612__en-us_topic_0224276697_response_Rs1321IdentityprovidersArritemLinks"></a><a name="en-us_topic_0224276697_response_Rs1321IdentityprovidersArritemLinks"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845612__en-us_topic_0224276697_response_Rs1321IdentityprovidersArritemLinks" frame="border" border="1" rules="all"><caption><b>Table 5 </b>identity_provider.links</caption><thead align="left"><tr id="en-us_topic_0057845612__en-us_topic_0224276697_row056210464456"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="en-us_topic_0057845612__en-us_topic_0224276697_p1356213463458"><strong id="en-us_topic_0057845612__b1337085252">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="en-us_topic_0057845612__en-us_topic_0224276697_p656384684515">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="en-us_topic_0057845612__en-us_topic_0224276697_p25631746194516">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845612__en-us_topic_0224276697_row0562646184512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p1956334615457">self</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p115641546144515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p1156464634517">Identity provider resource link.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__en-us_topic_0224276697_row2562204654510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p135640468454">protocols</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p85647469450">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0057845612__en-us_topic_0224276697_p195641946184510">Protocol resource link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845612__li3380214181916">Example response<pre class="screen" id="en-us_topic_0057845612__screen64603893104753">{
|
|
"identity_provider": {
|
|
"description": "Stores ACME identities",
|
|
"enabled": false,
|
|
"id": "ACME",
|
|
"sso_type": "iam_user_sso",
|
|
"remote_ids": [],
|
|
"links": {
|
|
"protocols": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME/protocols",
|
|
"self": "https://example.com/v3/OS-FEDERATION/identity_providers/ACME"
|
|
}
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845612__section2159974694223"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845612__table474896894223" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845612__row4100635794223"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845612__p3318059694223"><strong id="en-us_topic_0057845612__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_0057845612__p327374494223"><strong id="en-us_topic_0057845612__b38470707163018">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845612__row6384667294223"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845612__p419791694223">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845612__p448694194223">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__row4038247794223"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845612__p4975522494223">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845612__p364135694223">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__row3277220494223"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845612__p3730286394223">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845612__p163307194223">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__row1469764194223"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845612__p4965825494223">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845612__p6289565294223">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__row2918996194223"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845612__p1557661894223">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845612__p5374657794223">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__row1395714594223"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845612__p5678694594223">405</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845612__p3633980994223">The method specified in the request is not allowed for the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__row5862283094223"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845612__p5082879094223">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845612__p2349133994223">A resource conflict occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__row1009546194223"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845612__p1242604094223">413</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845612__p6698516394223">The request entity is too large.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__row6599555694223"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845612__p4403980294223">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845612__p1045424694223">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845612__row2697935094223"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845612__p3784377194223">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845612__p4544663394223">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>
|
|
|