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>
218 lines
17 KiB
HTML
218 lines
17 KiB
HTML
<a name="en-us_topic_0057845553"></a><a name="en-us_topic_0057845553"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Metadata File</h1>
|
|
<div id="body1492676120187"><div class="section" id="en-us_topic_0057845553__section46001270164832"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845553__p868514722110">This API is used to query the content of the metadata file imported by an identity provider to the IAM system.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845553__section47602695164832"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845553__ul30613081164832"><li id="en-us_topic_0057845553__li7082275164832">URI format<p id="en-us_topic_0057845553__p63740483164832"><a name="en-us_topic_0057845553__li7082275164832"></a><a name="li7082275164832"></a>GET /v3-ext/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}/metadata</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845553__ul62705518164832"><li id="en-us_topic_0057845553__li27478755164832">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845553__table45982210164832" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845553__row34412857164832"><th align="left" class="cellrowborder" valign="top" width="20.49%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0057845553__p35978026164832"><strong id="en-us_topic_0057845553__a6f95694edbbb43d8a152536754b86c82">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.09%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0057845553__p28538959164832"><strong id="en-us_topic_0057845553__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.11%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0057845553__p29954320164832"><strong id="en-us_topic_0057845553__a703d34a49a2f4162bc1a1a439f655f95_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.31%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0057845553__p10380887164832"><strong id="en-us_topic_0057845553__a76acf34e8e7b48948763ec1b460ad92f">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845553__row35545481164832"><td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p60611728164832">idp_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.09%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p10602964164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p53533756164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.31%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p41266993164832">ID of an identity provider.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row35858619164832"><td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p18867054164832">protocol _id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.09%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p51836385164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p37997628164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.31%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p57909032164832">ID of a protocol.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845553__section60120012164832"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845553__ul37882833164832"><li id="en-us_topic_0057845553__li5401183164832">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845553__table48610655164832" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845553__row34035357164832"><th align="left" class="cellrowborder" valign="top" width="20.22%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845553__p5400536164832"><strong id="en-us_topic_0057845553__b4342783220148">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.46%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845553__p34790247164832"><strong id="en-us_topic_0057845553__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.82%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845553__p66546611164832"><strong id="en-us_topic_0057845553__a703d34a49a2f4162bc1a1a439f655f95_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.5%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845553__p21566371164832"><strong id="en-us_topic_0057845553__b2131004320148">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845553__row2045599164832"><td class="cellrowborder" valign="top" width="20.22%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p31475856164832">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.46%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p66516446164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.82%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p19123056164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.5%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p5463727164832">Fill <strong id="en-us_topic_0057845553__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row49173546164832"><td class="cellrowborder" valign="top" width="20.22%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p23634327164832">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.46%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p35332324164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.82%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p43345977164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.5%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p64412052143925">Authenticated token with the <strong id="en-us_topic_0057845553__b750798910387">Security Administrator</strong> permission.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845553__ul52702749164832"><li id="en-us_topic_0057845553__li4562701164832">Example request<pre class="screen" id="en-us_topic_0057845553__screen41064316164832"><em id="en-us_topic_0057845553__i9610935132815">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-ext/OS-FEDERATION/identity_providers/ACME/protocols/saml/metadata</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845553__section34034532164832"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845553__ul5333670164832"><li id="en-us_topic_0057845553__li48003036164832">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845553__table29374141164832" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845553__row48948992164832"><th align="left" class="cellrowborder" valign="top" width="20.22%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845553__p5445443164832"><strong id="en-us_topic_0057845553__b304405620148">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.5%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845553__p38427718164832"><strong id="en-us_topic_0057845553__a105e6ed8c3de4c5a9dde97ae5a71071e_5">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.04%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845553__p25637425164832"><strong id="en-us_topic_0057845553__a703d34a49a2f4162bc1a1a439f655f95_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.239999999999995%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845553__p63365549164832"><strong id="en-us_topic_0057845553__b6402864920148">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845553__row32335841164832"><td class="cellrowborder" valign="top" width="20.22%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p1957494164832">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.5%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p24339348164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.04%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p25330146164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p38475912164832">ID of a metadata file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row10738892164832"><td class="cellrowborder" valign="top" width="20.22%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p64543914164832">idp_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.5%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p60674549164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.04%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p15691412164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p63044848164832">ID of an identity provider.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row30532720164832"><td class="cellrowborder" valign="top" width="20.22%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p57231217164832">entity_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.5%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p5216995164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.04%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p19923437164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p3185720164832"><strong id="en-us_topic_0057845553__b84235270618164">entityID</strong> field in the metadata file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row28671485164832"><td class="cellrowborder" valign="top" width="20.22%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p40688972164832">protocol_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.5%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p7472431164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.04%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p1287183164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p37152979164832">ID of a protocol.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row65941358164832"><td class="cellrowborder" valign="top" width="20.22%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p39649796164832">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.5%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p57516914164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.04%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p28358497164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p15336953164832">ID of the domain that a user belongs to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row3814851164832"><td class="cellrowborder" valign="top" width="20.22%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p40567530164832">xaccount_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.5%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p64744526164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.04%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p9815254164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p56838123164832">Domain source. The value is left empty by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row41781061164832"><td class="cellrowborder" valign="top" width="20.22%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p28822808164832">update_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.5%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p52946091164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.04%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p60774950164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p23823922164832">Time when a metadata file is imported or updated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row13088710164832"><td class="cellrowborder" valign="top" width="20.22%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845553__p53552557164832">data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.5%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845553__p42789881164832">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.04%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845553__p43428370164832">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.239999999999995%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845553__p28037087164832">Content of a metadata file.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845553__li16743916277">Example response<pre class="screen" id="en-us_topic_0057845553__screen14674119122711">{
|
|
"id": "40c174f35ff94e31b8257ad4991bce8b",
|
|
"idp_id": "ACME",
|
|
"entity_id": "https://idp.test.com/idp/shibboleth",
|
|
"protocol_id": "saml",
|
|
"domain_id": "ed7a77d365304f458f7d0a7909c6d889",
|
|
"xaccount_type": "",
|
|
"update_time": "2016-10-26T09:26:23.000000",
|
|
"data": "$data"}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845553__section5936311164832"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845553__table11079186164832" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845553__row37659029164832"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845553__p30482470164832"><strong id="en-us_topic_0057845553__b842352706104328">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_0057845553__p53161000164832"><strong id="en-us_topic_0057845553__b2836313720148">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845553__row11073730164832"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845553__p24556957164832">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845553__p42956513164832">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row51064297164832"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845553__p42567388164832">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845553__p25406412164832">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row27331118164832"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845553__p66336931164832">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845553__p4582345164832">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row41241110164832"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845553__p52195591164832">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845553__p67093374164832">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845553__row66969454164832"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845553__p55816678164832">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845553__p24857046164832">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845607.html">Metadata</a></div>
|
|
</div>
|
|
</div>
|
|
|