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>
218 lines
18 KiB
HTML
218 lines
18 KiB
HTML
<a name="en-us_topic_0057845639"></a><a name="en-us_topic_0057845639"></a>
|
|
|
|
<h1 class="topictitle1">Querying an Identity Provider</h1>
|
|
<div id="body1492676120167"><div class="section" id="en-us_topic_0057845639__section1157015294151"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845639__p654811108163">This API is used to query the information about an identity provider.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845639__section4603296894151"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845639__ul3768296094151"><li id="en-us_topic_0057845639__li360232294151">URI format<p id="en-us_topic_0057845639__p3242090494151"><a name="en-us_topic_0057845639__li360232294151"></a><a name="li360232294151"></a>GET /v3/OS-FEDERATION/identity_providers/{id}</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845639__ul2335268194151"><li id="en-us_topic_0057845639__li884754494151">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845639__table1251903794151" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845639__row1594222394151"><th align="left" class="cellrowborder" valign="top" width="22.21%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0057845639__p1625166694151"><strong id="en-us_topic_0057845639__a6f95694edbbb43d8a152536754b86c82">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.04%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0057845639__p4131654194151"><strong id="en-us_topic_0057845639__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.37%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0057845639__p5830552994151"><strong id="en-us_topic_0057845639__a703d34a49a2f4162bc1a1a439f655f95_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.379999999999995%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0057845639__p2512740594151"><strong id="en-us_topic_0057845639__b842352706114032_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845639__row2205395494151"><td class="cellrowborder" valign="top" width="22.21%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845639__p4153987294151">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.04%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845639__p928644694151">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.37%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845639__p1400462894151">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.379999999999995%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845639__p6063308394151">ID of an identity provider.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845639__section1233268294151"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845639__ul5942321094151"><li id="en-us_topic_0057845639__li6504684894151">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845639__table4855072394151" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845639__row279645794151"><th align="left" class="cellrowborder" valign="top" width="21.98219821982198%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845639__p2518650394151"><strong id="en-us_topic_0057845639__b20009936163129">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.45174517451745%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845639__p2684087394151"><strong id="en-us_topic_0057845639__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.13161316131613%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845639__p2662712894151"><strong id="en-us_topic_0057845639__a703d34a49a2f4162bc1a1a439f655f95_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.43444344434443%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845639__p931375594151"><strong id="en-us_topic_0057845639__b11975469163129">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845639__row1621669994151"><td class="cellrowborder" valign="top" width="21.98219821982198%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845639__p3848422394151">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.45174517451745%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845639__p3021435294151">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.13161316131613%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845639__p3144341394151">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.43444344434443%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845639__p6388850294151">Fill <strong id="en-us_topic_0057845639__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row3812561394151"><td class="cellrowborder" valign="top" width="21.98219821982198%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845639__p116698194151">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.45174517451745%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845639__p2741662194151">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.13161316131613%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845639__p615380594151">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.43444344434443%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845639__p34509161102440">Authenticated token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845639__li52929871203448">Example request<pre class="screen" id="en-us_topic_0057845639__screen2956678210321"><em id="en-us_topic_0057845639__i828511814210">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</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845639__section4269135194151"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845639__ul3544744194151"><li id="en-us_topic_0057845639__li5059152094151">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845639__table5267050094151" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845639__row6309797094151"><th align="left" class="cellrowborder" valign="top" width="21.867813218678133%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845639__p1066191394151"><strong id="en-us_topic_0057845639__b24391346163129">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.608239176082392%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845639__p5830864594151"><strong id="en-us_topic_0057845639__a105e6ed8c3de4c5a9dde97ae5a71071e_5">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845639__p2537983894151"><strong id="en-us_topic_0057845639__a703d34a49a2f4162bc1a1a439f655f95_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.195580441955805%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845639__p4250100394151"><strong id="en-us_topic_0057845639__b842352706114032_3">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845639__row28183437516"><td class="cellrowborder" valign="top" width="21.867813218678133%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845639__p481811435513">sso_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.608239176082392%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845639__p15818043254">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845639__p481894312517">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.195580441955805%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845639__p66471728101113">Identity provider type. The following two types are supported:</p>
|
|
<ul id="en-us_topic_0057845639__ul4812309115"><li id="en-us_topic_0057845639__li17989174441117"><strong id="en-us_topic_0057845639__b97641813164117">virtual_user_sso</strong>: The federated user is mapped to a virtual user after the login is redirected.</li><li id="en-us_topic_0057845639__li118183017119"><strong id="en-us_topic_0057845639__b17573131712411">iam_user_sso</strong>: The federated user is mapped to an IAM user after the login is redirected.</li></ul>
|
|
<p id="en-us_topic_0057845639__p14700152611110">The default value is <strong id="en-us_topic_0057845639__b17860202294115">virtual_user_sso</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row2002923794151"><td class="cellrowborder" valign="top" width="21.867813218678133%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845639__p1175549194151">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.608239176082392%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845639__p1267071894151">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845639__p1969521394151">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.195580441955805%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845639__p5180840994151">ID of an identity provider.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row6362249794151"><td class="cellrowborder" valign="top" width="21.867813218678133%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845639__p5314859494151">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.608239176082392%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845639__p1006885294151">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845639__p1027067094151">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.195580441955805%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845639__p2661796194151">Identity provider description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row3823506294151"><td class="cellrowborder" valign="top" width="21.867813218678133%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845639__p1003234194151">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.608239176082392%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845639__p731328894151">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845639__p17875329172823">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.195580441955805%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845639__p150721349439">Whether an identity provider is enabled.</p>
|
|
<ul id="en-us_topic_0057845639__ul4939885894312"><li id="en-us_topic_0057845639__li6353453094312"><strong id="en-us_topic_0057845639__b5446265494312">true</strong> indicates that the identity provider is enabled.</li><li id="en-us_topic_0057845639__li3690257494312"><strong id="en-us_topic_0057845639__b2040184294312">false</strong> indicates that the identity provider is disabled.</li></ul>
|
|
<p id="en-us_topic_0057845639__p38615584172823">The default value is <strong id="en-us_topic_0057845639__b10631473159329">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row222582054614"><td class="cellrowborder" valign="top" width="21.867813218678133%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845639__p586154154615">remote_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.608239176082392%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845639__p686224164611">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845639__p58621341134616">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.195580441955805%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845639__p7862114124617">Federated user ID list of an identity provider.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row6394731194151"><td class="cellrowborder" valign="top" width="21.867813218678133%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845639__p1234971794151">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.608239176082392%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845639__p6080302794151">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845639__p2609819494151">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.195580441955805%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845639__p3357900294151">Identity provider resource link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845639__li29669115184">Example response<pre class="screen" id="en-us_topic_0057845639__screen2919542210456">{
|
|
"identity_provider": {
|
|
"description": "Stores ACME identities",
|
|
"enabled": false,
|
|
"id": "ACME",
|
|
"sso_type": "iam_user_sso",
|
|
"remote_ids": [],
|
|
"links": {
|
|
"protocols": "https://<em id="en-us_topic_0057845639__i145110198204">sample.domain.com</em>/v3/OS-FEDERATION/identity_providers/ACME/protocols",
|
|
"self": "https://sample.domain.com/v3/OS-FEDERATION/identity_providers/ACME"
|
|
}
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845639__section5928057394151"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845639__table3699709194151" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845639__row4643214094151"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845639__p290701894151"><strong id="en-us_topic_0057845639__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_0057845639__p3414188094151"><strong id="en-us_topic_0057845639__b38470707163018">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845639__row1402886294151"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845639__p6259603794151">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845639__p3711422894151">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row6559260394151"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845639__p1140060294151">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845639__p5103355894151">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row5664883894151"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845639__p2515312794151">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845639__p2413740194151">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row1591001994151"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845639__p1364320194151">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845639__p3135750794151">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row1378211494151"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845639__p4260941394151">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845639__p2881046694151">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row5796760594151"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845639__p6486440994151">405</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845639__p1952577094151">The method specified in the request is not allowed for the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row4151420294151"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845639__p720720894151">413</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845639__p4691301594151">The request entity is too large.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row1956395994151"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845639__p4117680994151">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845639__p4698724894151">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845639__row2023205594151"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845639__p2818376894151">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845639__p118387394151">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>
|
|
|