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_0057845606.html
Wei, Hongmin 80f18fd272 IAM API 2.6 Version 
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>
2023-08-03 03:34:59 +00:00

323 lines
27 KiB
HTML
Raw Blame History

<a name="en-us_topic_0057845606"></a><a name="en-us_topic_0057845606"></a>
<h1 class="topictitle1">Creating an Identity Provider</h1>
<div id="body1492680701564"><div class="section" id="en-us_topic_0057845606__section1156121494041"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845606__p1966813201163">This API is provided for the administrator to create an identity provider.</p>
</div>
<div class="section" id="en-us_topic_0057845606__section3951742894041"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845606__ul4679513194041"><li id="en-us_topic_0057845606__li1850299594041">URI format<p id="en-us_topic_0057845606__p3230922994041"><a name="en-us_topic_0057845606__li1850299594041"></a><a name="li1850299594041"></a>PUT /v3/OS-FEDERATION/identity_providers/{id}</p>
</li></ul>
<ul id="en-us_topic_0057845606__ul6691077294041"><li id="en-us_topic_0057845606__li6532604394041">URI parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845606__table5106348094041" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845606__row5126430694041"><th align="left" class="cellrowborder" valign="top" width="20.352035203520348%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0057845606__p5876810194041"><strong id="en-us_topic_0057845606__b37426530113629">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.301730173017297%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0057845606__p6259571294041"><strong id="en-us_topic_0057845606__b842352706112524">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.23182318231823%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0057845606__p3708791694041"><strong id="en-us_topic_0057845606__b84235270615026">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.114411441144114%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0057845606__p5133121694041"><strong id="en-us_topic_0057845606__b14438018113629">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845606__row6418786194041"><td class="cellrowborder" valign="top" width="20.352035203520348%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845606__p3183427594041">id</p>
</td>
<td class="cellrowborder" valign="top" width="17.301730173017297%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845606__p2843945794041">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.23182318231823%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845606__p2189464794041">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.114411441144114%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845606__p2863598294041">ID of an identity provider.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845606__section3781319794041"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845606__ul4297014194041"><li id="en-us_topic_0057845606__li5118695594041">Parameters in the request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845606__table5802941494041" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845606__row2251960494041"><th align="left" class="cellrowborder" valign="top" width="20.34%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845606__p1214867494041"><strong id="en-us_topic_0057845606__b1687657131">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.34%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845606__p4451854894041"><strong id="en-us_topic_0057845606__b1782581021">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.94%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845606__p4923265994041"><strong id="en-us_topic_0057845606__b467033617">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.379999999999995%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845606__p2842243894041"><strong id="en-us_topic_0057845606__b1340686847">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845606__row2051615094041"><td class="cellrowborder" valign="top" width="20.34%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845606__p5119543494041">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845606__p5318948394041">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.94%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845606__p1338083294041">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.379999999999995%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845606__p1010558594041">Fill <strong id="en-us_topic_0057845606__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__row2384140894041"><td class="cellrowborder" valign="top" width="20.34%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845606__p5210592894041">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="17.34%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845606__p5983062494041">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.94%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845606__p1444235294041">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.379999999999995%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845606__p6357973814242">Authenticated token with the <strong id="en-us_topic_0057845606__b750798910387">Security Administrator</strong> permission.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845606__li5949226994041">Parameters in the request body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845606__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_0057845606__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_0057845606__en-us_topic_0224276933_p374464684514">Parameter</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_0057845606__en-us_topic_0224276933_p774474616453">Mandatory</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_0057845606__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_0057845606__en-us_topic_0224276933_p137451646114510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845606__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_0057845606__en-us_topic_0224276933_p11745446104512"><a href="#en-us_topic_0057845606__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_0057845606__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_0057845606__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_0057845606__en-us_topic_0224276933_p574624624518">Identity provider information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0057845606__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_0057845606__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_0057845606__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_0057845606__en-us_topic_0224276933_p1174784613456">Parameter</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_0057845606__en-us_topic_0224276933_p77471246174512">Mandatory</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_0057845606__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_0057845606__en-us_topic_0224276933_p8748246154514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845606__row63772198275"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="en-us_topic_0057845606__p337819193273">sso_type</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_0057845606__p153783192272">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_0057845606__p3378121911273">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_0057845606__p66471728101113">Identity provider type. The following two types are supported:</p>
<ul id="en-us_topic_0057845606__ul4812309115"><li id="en-us_topic_0057845606__li17989174441117"><strong id="en-us_topic_0057845606__b923412172406">virtual_user_sso</strong>: The federated user is mapped to a virtual user after the login is redirected.</li><li id="en-us_topic_0057845606__li118183017119"><strong id="en-us_topic_0057845606__b1334493284014">iam_user_sso</strong>: The federated user is mapped to an IAM user after the login is redirected. If you select this type, ensure that you have created an IAM user.</li></ul>
<p id="en-us_topic_0057845606__p14700152611110">The default value is <strong id="en-us_topic_0057845606__b164541656409">virtual_user_sso</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__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_0057845606__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_0057845606__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_0057845606__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_0057845606__en-us_topic_0224276933_p18749154634516">Description of the identity provider.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__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_0057845606__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_0057845606__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_0057845606__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_0057845606__en-us_topic_0224276933_p275024616452">Whether an identity provider is enabled. <strong id="en-us_topic_0057845606__b16473463405">true</strong> indicates that the identity provider is enabled. <strong id="en-us_topic_0057845606__b20647746174016">false</strong> indicates that the identity provider is disabled. The default value is <strong id="en-us_topic_0057845606__b16647104610407">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0057845606__ul4334942594041"><li id="en-us_topic_0057845606__li5460051194041">Example request<pre class="screen" id="en-us_topic_0057845606__en-us_topic_0224276933_screen1476016101316">PUT https://sample.domain.com/v3/OS-FEDERATION/identity_providers/{id}</pre>
<pre class="screen" id="en-us_topic_0057845606__en-us_topic_0224276933_screen0762546104517">{
"identity_provider": {
"description": "Stores ACME identities.",
"enabled": true
}
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845606__section2085259294041"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845606__ul1133838194041"><li id="en-us_topic_0057845606__li3493656794041">Parameters in the response body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p1854820469451">Parameter</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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p954824654513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845606__en-us_topic_0224276933_row5547446204513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0057845606__en-us_topic_0224276933_p195497463454"><a href="#en-us_topic_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p165491446134519">Identity provider information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0057845606__en-us_topic_0224276933_response_Rs1321IdentityprovidersArritem"></a><a name="en-us_topic_0224276933_response_Rs1321IdentityprovidersArritem"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845606__en-us_topic_0224276933_response_Rs1321IdentityprovidersArritem" frame="border" border="1" rules="all"><caption><b>Table 4 </b>identity_provider</caption><thead align="left"><tr id="en-us_topic_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p1855212466451">Parameter</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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p18554144624513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845606__row6736307349"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845606__p104900703412">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_0057845606__p449012715343">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_0057845606__p1982153761919">Identity provider type.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__en-us_topic_0224276933_row1055113468457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p15561146154517">Identity provider ID.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__en-us_topic_0224276933_row1055184616451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p255964634520">Description of the identity provider.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__en-us_topic_0224276933_row14551146154520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p12560124654514">Whether an identity provider is enabled. <strong id="en-us_topic_0057845606__b670310094115">true</strong> indicates that the identity provider is enabled. <strong id="en-us_topic_0057845606__b147031018411">false</strong> indicates that the identity provider is disabled. The default value is <strong id="en-us_topic_0057845606__b97031504412">false</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__en-us_topic_0224276933_row6551946124516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p75611346164519">Federated user ID list of an identity provider.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__en-us_topic_0224276933_row19551446114516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845606__en-us_topic_0224276933_p1256194664518"><a href="#en-us_topic_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p1856194616459">Identity provider resource link.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0057845606__en-us_topic_0224276933_response_Rs1321IdentityprovidersArritemLinks"></a><a name="en-us_topic_0224276933_response_Rs1321IdentityprovidersArritemLinks"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p1356213463458">Parameter</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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p25631746194516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845606__en-us_topic_0224276933_row0562646184512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p1156464634517">Identity provider resource link.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__en-us_topic_0224276933_row2562204654510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_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_0057845606__en-us_topic_0224276933_p195641946184510">Protocol resource link.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845606__li2938164241814">Example response<pre class="screen" id="en-us_topic_0057845606__screen61408896103312">{
"identity_provider": {
"description": "Stores ACME identities",
"enabled": true,
"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_0057845606__section4456313094041"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845606__table5284375594041" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845606__row1009137094041"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845606__p1209461894041"><strong id="en-us_topic_0057845606__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_0057845606__p4014001194041"><strong id="en-us_topic_0057845606__b38470707163018">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845606__row3011546094041"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845606__p2343323094041">201</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845606__p1904350594041">The request is successful.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__row3717381994041"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845606__p5828933394041">400</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845606__p2381551594041">The server failed to process the request.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__row1301305194041"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845606__p4742420794041">401</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845606__p1615558894041">Authentication failed.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__row1118257094041"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845606__p3337301194041">403</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845606__p1885937694041">Access denied.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__row3551666294041"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845606__p5827737394041">404</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845606__p2284676494041">The requested resource cannot be found.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__row429429194041"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845606__p1229326694041">405</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845606__p5623047894041">The method specified in the request is not allowed for the requested resource.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__row11885125610385"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845606__p888675653816">409</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845606__p3786276397">Duplicate identity provider ID.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__row3631225494041"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845606__p5561142394041">413</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845606__p823140994041">The request entity is too large.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__row697381994041"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845606__p2800850594041">500</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845606__p5409644394041">Internal server error.</p>
</td>
</tr>
<tr id="en-us_topic_0057845606__row1710594694041"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845606__p4340434994041">503</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845606__p2609141894041">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>
View Git Blame Copy Permalink