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>
162 lines
10 KiB
HTML
162 lines
10 KiB
HTML
<a name="iam_08_0012"></a><a name="iam_08_0012"></a>
|
|
|
|
<h1 class="topictitle1">Querying MFA Device Information of Users</h1>
|
|
<div id="body1597737539339"><div class="section" id="iam_08_0012__section127695529365"><h4 class="sectiontitle">Function</h4><p id="iam_08_0012__p1185665293618">This API is provided for the administrator to query the MFA device information of users.</p>
|
|
</div>
|
|
<div class="section" id="iam_08_0012__section4772205220365"><h4 class="sectiontitle">URI</h4><p id="iam_08_0012__p11856152103614">GET /v3.0/OS-MFA/virtual-mfa-devices</p>
|
|
</div>
|
|
<div class="section" id="iam_08_0012__section677245203611"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0012__table877395263619" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_08_0012__row585605215369"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_08_0012__p185616522369">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.5.1.2"><p id="iam_08_0012__p98561252163613">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="iam_08_0012__p28561952103613">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.5.1.4"><p id="iam_08_0012__p1385625223610">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0012__row128561521365"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_08_0012__p08567521369">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_08_0012__p14856952113610">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_08_0012__p6856145214366">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_08_0012__p9856152143613">Token with <strong id="iam_08_0012__b1413064734411">Security Administrator</strong> permissions.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_08_0012__section57801752113615"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0012__table1578115211360" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response body</caption><thead align="left"><tr id="iam_08_0012__row12856152143611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.1"><p id="iam_08_0012__p1185617528362">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.15%" id="mcps1.3.4.2.2.4.1.2"><p id="iam_08_0012__p28561452183616">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.85%" id="mcps1.3.4.2.2.4.1.3"><p id="iam_08_0012__p198561952143619">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0012__row185616526363"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="iam_08_0012__p785645211367"><a href="#iam_08_0012__table578318529362">virtual_mfa_devices</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.15%" headers="mcps1.3.4.2.2.4.1.2 "><p id="iam_08_0012__p168561529369">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.85%" headers="mcps1.3.4.2.2.4.1.3 "><p id="iam_08_0012__p17856135210369">Virtual MFA device information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_08_0012__table578318529362"></a><a name="table578318529362"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0012__table578318529362" frame="border" border="1" rules="all"><caption><b>Table 3 </b>virtual_mfa_devices</caption><thead align="left"><tr id="iam_08_0012__row158561525360"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="iam_08_0012__p18856155213619">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.15%" id="mcps1.3.4.3.2.4.1.2"><p id="iam_08_0012__p14856135263618">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.85%" id="mcps1.3.4.3.2.4.1.3"><p id="iam_08_0012__p1085611524364">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0012__row485675214368"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0012__p1885613521369">serial_number</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0012__p4856145243611">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.85%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0012__p1385616523366">Virtual MFA device serial number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0012__row168561952103618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0012__p13856195211368">user_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0012__p585685210367">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.85%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0012__p15856152173618">User ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_08_0012__section5786175216364"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_08_0012__screen28561152203619">GET https://sample.domain.com/v3.0/OS-MFA/virtual-mfa-devices</pre>
|
|
</div>
|
|
<div class="section" id="iam_08_0012__section8787165233611"><h4 class="sectiontitle">Example Response</h4><p id="iam_08_0012__p16857155243619"><strong id="iam_08_0012__b827595121710">Status code: 200</strong></p>
|
|
<p id="iam_08_0012__p985765218367">The request is successful.</p>
|
|
<pre class="screen" id="iam_08_0012__screen1385714526362">{
|
|
"virtual_mfa_devices" : [
|
|
{
|
|
"user_id" : "16b26081f43d4c628c4bb88cf32e9...",
|
|
"serial_number" : "iam/mfa/16b26081f43d4c628c4bb88cf32e9..."
|
|
},
|
|
{
|
|
"user_id" : "47026081f43d4c628c4bb88cf32e9...",
|
|
"serial_number" : "iam/mfa/75226081f43d4c628c4bb88cf32e9..."
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<p id="iam_08_0012__p6630124621810"><strong id="iam_08_0012__b22581283174">Status code: 403</strong></p>
|
|
<p id="iam_08_0012__p186301446161810">Access denied.</p>
|
|
<ul id="iam_08_0012__ul156301846171818"><li id="iam_08_0012__li76307462186">Example 1</li></ul>
|
|
<pre class="screen" id="iam_08_0012__screen2121196111913">{
|
|
"error_msg" : "You are not authorized to perform the requested action.",
|
|
"error_code" : "IAM.0002"
|
|
}</pre>
|
|
<ul id="iam_08_0012__ul14845167131920"><li id="iam_08_0012__li48451779191">Example 2</li></ul>
|
|
<pre class="screen" id="iam_08_0012__screen18992181211916">{
|
|
"error_msg" : "Policy doesn't allow %(actions)s to be performed.",
|
|
"error_code" : "IAM.0003"
|
|
}</pre>
|
|
<p id="iam_08_0012__p1463044618184"><strong id="iam_08_0012__b279581191718">Status code: 404</strong></p>
|
|
<p id="iam_08_0012__p763024612181">The requested resource cannot be found.</p>
|
|
<pre class="screen" id="iam_08_0012__screen863016461182">{
|
|
"error_msg" : "Could not find %(target)s: %(target_id)s.",
|
|
"error_code" : "IAM.0004"
|
|
}</pre>
|
|
<p id="iam_08_0012__p1663054681816"><strong id="iam_08_0012__b17724121417173">Status code: 500</strong></p>
|
|
<p id="iam_08_0012__p263024621818">Internal server error.</p>
|
|
<pre class="screen" id="iam_08_0012__screen5630194613182">{
|
|
"error_msg" : "An unexpected error prevented the server from fulfilling your request.",
|
|
"error_code" : "IAM.0006"
|
|
}</pre>
|
|
<div class="section" id="iam_08_0012__section1879275213615"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0012__table07921452193618" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_08_0012__row1285775212365"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.19.2.1.3.1.1"><p id="iam_08_0012__p17857105263613">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.19.2.1.3.1.2"><p id="iam_08_0012__p138573528362">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0012__row1785745223617"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_08_0012__p485745283614">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_08_0012__p16857115211367">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0012__row108577522366"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_08_0012__p28574528360">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_08_0012__p38571852123613">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0012__row5857185213618"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_08_0012__p8857552153619">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_08_0012__p58571052193617">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0012__row16857205215368"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_08_0012__p2857185243613">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_08_0012__p208577526367">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0012__row108574529360"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_08_0012__p1485745212361">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_08_0012__p2857155215368">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="iam_02_0020.html">Security Settings</a></div>
|
|
</div>
|
|
</div>
|
|
|