doc-exports/docs/iam/api-ref/en-us_topic_0057845577.html
zhangyue 3b5a58b1fe IAM API 2.0.38
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2022-10-26 04:31:24 +00:00

113 lines
8.0 KiB
HTML

<a name="en-us_topic_0057845577"></a><a name="en-us_topic_0057845577"></a>
<h1 class="topictitle1">Querying the Metadata File of Keystone</h1>
<div id="body1492676120188"><div class="section" id="en-us_topic_0057845577__section5290716016471"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845577__p1352072842214">This API is used to query the metadata file of the keystone.</p>
<p id="en-us_topic_0057845577__p369408816276"></p>
</div>
<div class="section" id="en-us_topic_0057845577__section6523849916310"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0057845577__p2166278516484">GET /v3-ext/auth/OS-FEDERATION/SSO/metadata</p>
</div>
<div class="section" id="en-us_topic_0057845577__section3867762216471"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845577__ul323797316471"><li id="en-us_topic_0057845577__li3422324216350">Parameters in the request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845577__table4721442116350" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845577__row4043595516350"><th align="left" class="cellrowborder" valign="top" width="17.478252174782526%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845577__p3628647916350"><strong id="en-us_topic_0057845577__a6f95694edbbb43d8a152536754b86c82">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.858214178582145%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845577__p5352366316350"><strong id="en-us_topic_0057845577__a105e6ed8c3de4c5a9dde97ae5a71071e">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.23807619238076%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845577__p4044945616350"><strong id="en-us_topic_0057845577__a703d34a49a2f4162bc1a1a439f655f95">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.42545745425458%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845577__p5518050516350"><strong id="en-us_topic_0057845577__a76acf34e8e7b48948763ec1b460ad92f">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845577__row4351522316350"><td class="cellrowborder" valign="top" width="17.478252174782526%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845577__p5408695016350">unsigned</p>
</td>
<td class="cellrowborder" valign="top" width="17.858214178582145%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845577__p1896680916350">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.23807619238076%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845577__p5991653216350">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45.42545745425458%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845577__p2140092816350">Whether to sign metadata according to SAML 2.0 specifications. The default value of this parameter is <strong id="en-us_topic_0057845577__b924724683161328">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845577__li1574678164721">Example request<pre class="screen" id="en-us_topic_0057845577__screen4146553164731"><em id="en-us_topic_0057845577__i1253994717168">GET /v3-ext/auth</em><em id="en-us_topic_0057845577__i792811414160">/OS-FEDERATION/SSO/metadata</em></pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845577__section35305061164019"><h4 class="sectiontitle">Response Parameters</h4><p id="en-us_topic_0057845577__p56354611164030">Example response</p>
<pre class="screen" id="en-us_topic_0057845577__screen5445007164048">&lt;md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" ID="43ebac773925f6849b196a3c803baba5" entityID="https://www.example.com"&gt;
&lt;ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"&gt;
&lt;ds:SignedInfo&gt;
&lt;ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/&gt;
&lt;ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/&gt;
&lt;ds:Reference URI="#43ebac773925f6849b196a3c803baba5"&gt;
&lt;ds:Transforms&gt;
&lt;ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/&gt;
&lt;ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/&gt;
&lt;/ds:Transforms&gt;
&lt;ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/&gt;
&lt;ds:DigestValue&gt;yuQJc6OI3xilt6X4cOEUBnVV2Vs=&lt;/ds:DigestValue&gt;
&lt;/ds:Reference&gt;
&lt;/ds:SignedInfo&gt;
&lt;ds:SignatureValue&gt;...&lt;/ds:SignatureValue&gt;
&lt;ds:KeyInfo&gt;
&lt;ds:X509Data&gt;
&lt;ds:X509Certificate&gt;...&lt;/ds:X509Certificate&gt;
&lt;/ds:X509Data&gt;
&lt;/ds:KeyInfo&gt;
&lt;/ds:Signature&gt;
&lt;md:SPSSODescriptor AuthnRequestsSigned="true" WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"&gt;
&lt;md:KeyDescriptor use="signing"&gt;
&lt;ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#"&gt;
&lt;ds:X509Data&gt;
&lt;ds:X509Certificate&gt;...&lt;/ds:X509Certificate&gt;
&lt;/ds:X509Data&gt;
&lt;/ds:KeyInfo&gt;
&lt;/md:KeyDescriptor&gt;
&lt;md:KeyDescriptor use="encryption"&gt;
&lt;ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#"&gt;
&lt;ds:X509Data&gt;
&lt;ds:X509Certificate&gt;...&lt;/ds:X509Certificate&gt;
&lt;/ds:X509Data&gt;
&lt;/ds:KeyInfo&gt;
&lt;/md:KeyDescriptor&gt;
&lt;md:NameIDFormat xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata"&gt;
urn:oasis:names:tc:SAML:2.0:nameid-format:transient
&lt;/md:NameIDFormat&gt;
&lt;md:AssertionConsumerService xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://www.example.com/v3-ext/auth/OS-FEDERATION/SSO/SAML2/POST" index="0" isDefault="true"/&gt;
&lt;md:AssertionConsumerService xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" Binding="urn:oasis:names:tc:SAML:2.0:bindings:PAOS" Location="https://www.example.com/v3-ext/auth/OS-FEDERATION/SSO/SAML2/ECP" index="1"/&gt;
&lt;/md:SPSSODescriptor&gt;
&lt;/md:EntityDescriptor&gt;</pre>
</div>
<div class="section" id="en-us_topic_0057845577__section1813979416471"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845577__table6003723016471" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845577__row4559823416471"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845577__p246947316471"><strong id="en-us_topic_0057845577__b842352706183043">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_0057845577__p6580961616471"><strong id="en-us_topic_0057845577__b34543959162842">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845577__row2897870416471"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845577__p6557370516471">200</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845577__p986985816471">The request is successful.</p>
</td>
</tr>
<tr id="en-us_topic_0057845577__row2171985816471"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845577__p1447804616471">500</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845577__p3187110316471">Internal server error.</p>
</td>
</tr>
<tr id="en-us_topic_0057845577__row1840447916471"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845577__p1436785016471">503</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845577__p2294521416471">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_0057845607.html">Metadata</a></div>
</div>
</div>