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>
148 lines
11 KiB
HTML
148 lines
11 KiB
HTML
<a name="en-us_topic_0057845596"></a><a name="en-us_topic_0057845596"></a>
|
|
|
|
<h1 class="topictitle1">Querying the List of Domains Accessible to Federated Users</h1>
|
|
<div id="body1492741255667"><div class="section" id="en-us_topic_0057845596__section58789816165237"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845596__p2070862812319">This API is used to query the list of domains accessible to federated users.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845596__section52559452192324"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0057845596__p35104473192156">GET /v3/OS-FEDERATION/domains</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845596__section37561902165237"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845596__ul32502032165237"><li id="en-us_topic_0057845596__li56994705193643">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845596__table6425434193643" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845596__row58375964193643"><th align="left" class="cellrowborder" valign="top" width="21.42%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845596__p4016564193643"><strong id="en-us_topic_0057845596__a6f95694edbbb43d8a152536754b86c82">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.689999999999998%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845596__p56906283193643"><strong id="en-us_topic_0057845596__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.89%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845596__p46006239193643"><strong id="en-us_topic_0057845596__a703d34a49a2f4162bc1a1a439f655f95_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845596__p35517879193643"><strong id="en-us_topic_0057845596__a76acf34e8e7b48948763ec1b460ad92f">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845596__row16486847193643"><td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845596__p30832629193643">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.689999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845596__p14415019193643">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.89%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845596__p26765861193643">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845596__p50742315193643">Unscoped token. For details, see <a href="en-us_topic_0057845629.html">Obtaining an Unscoped Token (SP Initiated)</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="en-us_topic_0057845596__note53630432193643"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en-us_topic_0057845596__p39924152193657">The API described in <a href="en-us_topic_0057845574.html">Querying the List of Domains Accessible to Users</a> is recommended. This API returns the same response format as the API described in this section.</p>
|
|
</div></div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845596__ul62592568193650"><li id="en-us_topic_0057845596__li24082832165237">Example request<pre class="screen" id="en-us_topic_0057845596__screen15418897165237"><em id="en-us_topic_0057845596__i15443141643518">GET /v3/OS-FEDERATION/domains</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845596__section40971139165237"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845596__ul52052101194039"><li id="en-us_topic_0057845596__li43272935194039">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845596__table30327949165237" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845596__row21947087165237"><th align="left" class="cellrowborder" valign="top" width="21.55%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845596__p32883631165237"><strong id="en-us_topic_0057845596__b33528600105430">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.82%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845596__p46328435165237"><strong id="en-us_topic_0057845596__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.63%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845596__p61615748165237"><strong id="en-us_topic_0057845596__a703d34a49a2f4162bc1a1a439f655f95_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845596__p24819657165237"><strong id="en-us_topic_0057845596__b9974812105430">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845596__row64235178165237"><td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845596__p35666961165237">domains</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.82%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845596__p3342691165237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845596__p2322570165237">array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845596__p53910510165237">List of domains.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845596__row15432546165237"><td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845596__p42076715165237">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.82%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845596__p52770789165237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845596__p46575544165237">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845596__p14522699165237">Domain resource link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845596__ul63595428165237"><li id="en-us_topic_0057845596__li35487942165237">Example response<pre class="screen" id="en-us_topic_0057845596__screen130455193039">{
|
|
"domains": [
|
|
{
|
|
"links": {
|
|
"self": "https://<em id="en-us_topic_0057845596__i1589717271191">sample.domain.com</em>/v3/domains/e31ac82d778b4d128cb6fed37fd72cdb"
|
|
},
|
|
"description": null,
|
|
"name": "exampledomain",
|
|
"enabled": true,
|
|
"id": "e31ac82d778b4d128cb6fed37fd72cdb"
|
|
}
|
|
],
|
|
"links": {
|
|
"self": "https://<em id="en-us_topic_0057845596__i58535339911">sample.domain.com</em>/v3/OS-FEDERATION/domains",
|
|
"previous": null,
|
|
"next": null
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845596__section15537603165237"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845596__table50586344165237" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845596__row57508784165237"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845596__p27699899165237"><strong id="en-us_topic_0057845596__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_0057845596__p29099351165237"><strong id="en-us_topic_0057845596__b38470707163018">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845596__row8237227165237"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845596__p63235680165237">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845596__p21816478165237">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845596__row62130575165237"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845596__p66520684165237">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845596__p19466342165237">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845596__row40979353165237"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845596__p30993288165237">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845596__p27428424165237">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845596__row45529230165237"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845596__p63989002165237">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845596__p15726634165237">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845596__row7321979165237"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845596__p56209421165237">405</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845596__p56669239165237">The method specified in the request is not allowed for the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845596__row40261109165237"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845596__p39924407165237">413</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845596__p12651558165237">The request entity is too large.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845596__row46755161165237"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845596__p29071734165237">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845596__p6000243165237">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845596__row54002189165237"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845596__p12101182165237">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845596__p40671651165237">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_0057845633.html">Domain</a></div>
|
|
</div>
|
|
</div>
|
|
|