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>
186 lines
12 KiB
HTML
186 lines
12 KiB
HTML
<a name="iam_08_0014"></a><a name="iam_08_0014"></a>
|
|
|
|
<h1 class="topictitle1">Querying Login Protection Configurations of Users</h1>
|
|
<div id="body1597737539340"><div class="section" id="iam_08_0014__section11479143317372"><h4 class="sectiontitle">Function</h4><p id="iam_08_0014__p155381033103713">This API is provided for the administrator to query the login protection configurations of users.</p>
|
|
</div>
|
|
<div class="section" id="iam_08_0014__section1547914332370"><h4 class="sectiontitle">URI</h4><p id="iam_08_0014__p1553823333711">GET /v3.0/OS-USER/login-protects</p>
|
|
</div>
|
|
<div class="section" id="iam_08_0014__section1747943313720"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0014__table1480103393713" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_08_0014__row153843343710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_08_0014__p1753811337372">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_0014__p1353893393713">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_0014__p11538163310379">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_0014__p453810333376">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0014__row1753816337379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_08_0014__p16538183353717">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_0014__p17538193363715">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_08_0014__p3538133317375">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_08_0014__p953853315377">Token with <strong id="iam_08_0014__b10755153454">Security Administrator</strong> permissions.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_08_0014__section2482123311375"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0014__table1548263312379" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response body</caption><thead align="left"><tr id="iam_08_0014__row25381433153712"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.1"><p id="iam_08_0014__p12538163310373">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.2"><p id="iam_08_0014__p105389334371">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.2.4.1.3"><p id="iam_08_0014__p185387338371">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0014__row153893323718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="iam_08_0014__p10538193383720"><a href="#iam_08_0014__table12484173313717">login_protects</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.2 "><p id="iam_08_0014__en-us_topic_0221482398_p1780653742313">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.2.4.1.3 "><p id="iam_08_0014__p1053883393718">Login protection configurations.</p>
|
|
<div class="note" id="iam_08_0014__note5470185314417"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="iam_08_0014__p124704534413">The response only includes the login protection configurations of users for whom login protection has been configured.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_08_0014__table12484173313717"></a><a name="table12484173313717"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0014__table12484173313717" frame="border" border="1" rules="all"><caption><b>Table 3 </b>login_protects</caption><thead align="left"><tr id="iam_08_0014__row175381433193717"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="iam_08_0014__p6538173303720">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="iam_08_0014__p10538733113715">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="iam_08_0014__p12538143323716">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0014__row153813310373"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0014__p45381833123711">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0014__p253813332371">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0014__p1653873313716">Indicates whether login protection has been enabled for a user. The value can be <strong id="iam_08_0014__b27554126207">true</strong> or <strong id="iam_08_0014__b1676041202011">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0014__row1053823313720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0014__p14538433143720">user_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0014__p18538333153720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0014__p175387339379">User ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0014__row4538103311375"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0014__p15538163343710">verification_method</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0014__p195386339374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0014__p16538933113714">Login authentication method of the user.</p>
|
|
<ul id="iam_08_0014__ul4681172414548"><li id="iam_08_0014__li16681424105413"><strong id="iam_08_0014__b1854334119152">email</strong>: email verification code</li><li id="iam_08_0014__li1241683619548"><strong id="iam_08_0014__b62612047181512">vmfa</strong>: virtual MFA verification code</li><li id="iam_08_0014__li8959547155410"><strong id="iam_08_0014__b109177212168">SMS</strong>: SMS verification code</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_08_0014__section134881533163720"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_08_0014__screen453817331372">GET https://sample.domain.com/v3.0/OS-USER/login-protects</pre>
|
|
</div>
|
|
<div class="section" id="iam_08_0014__section12488103313717"><h4 class="sectiontitle">Example Response</h4><p id="iam_08_0014__p253873319376"><strong id="iam_08_0014__b1766802212011">Status code: 200</strong></p>
|
|
<p id="iam_08_0014__p05381533143710">The request is successful.</p>
|
|
<pre class="screen" id="iam_08_0014__screen853883393716">{
|
|
"login_protects" : [
|
|
{
|
|
"user_id" : "75226081f43d4c628c4bb88cf32e9...",
|
|
"enabled" : true,
|
|
"verification_method" : "email"
|
|
},
|
|
{
|
|
"user_id" : "16b26081f43d4c628c4bb88cf32e9...",
|
|
"enabled" : true,
|
|
"verification_method" : "vmfa"
|
|
},
|
|
{
|
|
"user_id" : "56b26081f43d4c628c4bb88cf32e9...",
|
|
"enabled" : true,
|
|
"verification_method" : "sms"
|
|
}
|
|
{
|
|
"user_id" : "08c16cb6c58010691f81c0028dd94...",
|
|
"enabled" : false,
|
|
"verification_method" : "none"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="note" id="iam_08_0014__note103471733116"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="iam_08_0014__p350819373373">If login protection has never been configured for a user, you cannot use this API to obtain the login protection configuration of the user.</p>
|
|
</div></div>
|
|
<p id="iam_08_0014__p1763120671617"><strong id="iam_08_0014__b12454224192019">Status code: 403</strong></p>
|
|
<p id="iam_08_0014__p5632126191613">Access denied.</p>
|
|
<ul id="iam_08_0014__ul9632166151613"><li id="iam_08_0014__li116321262164">Example 1</li></ul>
|
|
<pre class="screen" id="iam_08_0014__screen13940131120164">{
|
|
"error_msg" : "You are not authorized to perform the requested action.",
|
|
"error_code" : "IAM.0002"
|
|
}</pre>
|
|
<ul id="iam_08_0014__ul203651136163"><li id="iam_08_0014__li136418133168">Example 2</li></ul>
|
|
<pre class="screen" id="iam_08_0014__screen207448162166">{
|
|
"error_msg" : "Policy doesn't allow %(actions)s to be performed.",
|
|
"error_code" : "IAM.0003"
|
|
}</pre>
|
|
<p id="iam_08_0014__p86321767165"><strong id="iam_08_0014__b176541288203">Status code: 404</strong></p>
|
|
<p id="iam_08_0014__p106326661613">The requested resource cannot be found.</p>
|
|
<pre class="screen" id="iam_08_0014__screen1263213651613">{
|
|
"error_msg" : "Could not find %(target)s: %(target_id)s.",
|
|
"error_code" : "IAM.0004"
|
|
}</pre>
|
|
<p id="iam_08_0014__p136321660162"><strong id="iam_08_0014__b1528573010201">Status code: 500</strong></p>
|
|
<p id="iam_08_0014__p116324691617">Internal server error.</p>
|
|
<pre class="screen" id="iam_08_0014__screen1763213661617">{
|
|
"error_msg" : "An unexpected error prevented the server from fulfilling your request.",
|
|
"error_code" : "IAM.0006"
|
|
}</pre>
|
|
<div class="section" id="iam_08_0014__section949293313371"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0014__table349212337371" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_08_0014__row175391533113720"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.20.2.1.3.1.1"><p id="iam_08_0014__p19539183363710">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.20.2.1.3.1.2"><p id="iam_08_0014__p653914337371">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0014__row15392033133711"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.20.2.1.3.1.1 "><p id="iam_08_0014__p353993312372">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.20.2.1.3.1.2 "><p id="iam_08_0014__p19539193315373">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0014__row153915335371"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.20.2.1.3.1.1 "><p id="iam_08_0014__p15391733143713">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.20.2.1.3.1.2 "><p id="iam_08_0014__p5539113353720">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0014__row165391633133713"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.20.2.1.3.1.1 "><p id="iam_08_0014__p16539143363711">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.20.2.1.3.1.2 "><p id="iam_08_0014__p75391133163717">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0014__row653913316373"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.20.2.1.3.1.1 "><p id="iam_08_0014__p155391333173720">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.20.2.1.3.1.2 "><p id="iam_08_0014__p11539103313712">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0014__row1553973318376"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.20.2.1.3.1.1 "><p id="iam_08_0014__p16539143314373">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.20.2.1.3.1.2 "><p id="iam_08_0014__p165397331379">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>
|
|
|