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>
230 lines
16 KiB
HTML
230 lines
16 KiB
HTML
<a name="iam_08_0021"></a><a name="iam_08_0021"></a>
|
|
|
|
<h1 class="topictitle1">Modifying the Login Protection Configuration of a User</h1>
|
|
<div id="body1604926565941"><div class="section" id="iam_08_0021__section6273126173813"><h4 class="sectiontitle">Function</h4><p id="iam_08_0021__p194107267388">This API is provided for the administrator to modify the login protection configuration of a user.</p>
|
|
</div>
|
|
<div class="section" id="iam_08_0021__section1427613263382"><h4 class="sectiontitle">URI</h4><p id="iam_08_0021__p17410526173818">PUT /v3.0/OS-USER/users/{user_id}/login-protect</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0021__table10277192683817" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="iam_08_0021__row104101126103814"><th align="left" class="cellrowborder" valign="top" width="19.18%" id="mcps1.3.2.3.2.5.1.1"><p id="iam_08_0021__p74101126173819">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.9%" id="mcps1.3.2.3.2.5.1.2"><p id="iam_08_0021__p174102026153816">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.830000000000002%" id="mcps1.3.2.3.2.5.1.3"><p id="iam_08_0021__p144101026103813">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.09%" id="mcps1.3.2.3.2.5.1.4"><p id="iam_08_0021__p141082611381">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0021__row1841062610383"><td class="cellrowborder" valign="top" width="19.18%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_08_0021__p841092611386">user_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.9%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_08_0021__p241013263383">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_08_0021__p741032610381">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.09%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_08_0021__en-us_topic_0221482404_p1141817101324">ID of the user whose login protection configuration is to be modified.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_08_0021__section18284112614387"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0021__table42843262380" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_08_0021__row1141092614388"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_08_0021__p4410192613815">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.459999999999999%" id="mcps1.3.3.2.2.5.1.2"><p id="iam_08_0021__p6410826123815">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.830000000000002%" id="mcps1.3.3.2.2.5.1.3"><p id="iam_08_0021__p194111826103812">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.010000000000005%" id="mcps1.3.3.2.2.5.1.4"><p id="iam_08_0021__p10411126143814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0021__row1541132613383"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_08_0021__p20411126123820">X-Auth-token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.459999999999999%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_08_0021__p1141172619385">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.830000000000002%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_08_0021__p54111626123812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.010000000000005%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_08_0021__en-us_topic_0221482404_p1425111014328">Token with <strong id="iam_08_0021__b14180182813451">Security Administrator</strong> permissions.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0021__table828862610381" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request body</caption><thead align="left"><tr id="iam_08_0021__row114114263388"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.3.3.2.5.1.1"><p id="iam_08_0021__p17411726123820">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.2%" id="mcps1.3.3.3.2.5.1.2"><p id="iam_08_0021__p174111426183812">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.09%" id="mcps1.3.3.3.2.5.1.3"><p id="iam_08_0021__p15411626163812">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.66%" id="mcps1.3.3.3.2.5.1.4"><p id="iam_08_0021__p6411192612383">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0021__row12411826143812"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.3.2.5.1.1 "><p id="iam_08_0021__p17411182643813"><a href="#iam_08_0021__table14291172683815">login_protect</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.2%" headers="mcps1.3.3.3.2.5.1.2 "><p id="iam_08_0021__p20411172619386">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.3.3.2.5.1.3 "><p id="iam_08_0021__p04111026173811">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.66%" headers="mcps1.3.3.3.2.5.1.4 "><p id="iam_08_0021__p124111026173817">Login protection configuration.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_08_0021__table14291172683815"></a><a name="table14291172683815"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0021__table14291172683815" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Login_project</caption><thead align="left"><tr id="iam_08_0021__row11411626133814"><th align="left" class="cellrowborder" valign="top" width="20.23%" id="mcps1.3.3.4.2.5.1.1"><p id="iam_08_0021__p34111526103811">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.94%" id="mcps1.3.3.4.2.5.1.2"><p id="iam_08_0021__p3411132615389">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.52%" id="mcps1.3.3.4.2.5.1.3"><p id="iam_08_0021__p941162673817">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.31%" id="mcps1.3.3.4.2.5.1.4"><p id="iam_08_0021__p641162618382">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0021__row1641192693814"><td class="cellrowborder" valign="top" width="20.23%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0021__p0411142653811">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.94%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0021__p5411126193814">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0021__p341102611384">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.31%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0021__p35197507377">Indicates whether login protection has been enabled for the user. The value can be <strong id="iam_08_0021__b12949944175114">true</strong> or <strong id="iam_08_0021__b496244411514">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0021__row10411112693816"><td class="cellrowborder" valign="top" width="20.23%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0021__p441162610389">verification_method</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.94%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0021__p15411726103817">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0021__p174115262382">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.31%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0021__p1411112614384">Login authentication method of the user. Options: <strong id="iam_08_0021__b125771375529">sms</strong>, <strong id="iam_08_0021__b0831113835212">email</strong>, and <strong id="iam_08_0021__b194391040175212">vmfa</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_08_0021__section629419260382"><h4 class="sectiontitle">Response Parameters</h4><p id="iam_08_0021__p164111626163811"><strong id="iam_08_0021__b1966114245215">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0021__table12295152616381" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters in the response body</caption><thead align="left"><tr id="iam_08_0021__row9411132618385"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="iam_08_0021__p194121126153817">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_0021__p6412152613388">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_0021__p5412112633813">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0021__row141213266387"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0021__p18412182653810"><a href="#iam_08_0021__table13297726203815">login_protect</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0021__p2412152610389">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0021__p13412152613816">Login protection configuration.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_08_0021__table13297726203815"></a><a name="table13297726203815"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0021__table13297726203815" frame="border" border="1" rules="all"><caption><b>Table 6 </b>login_protect</caption><thead align="left"><tr id="iam_08_0021__row104121626173811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="iam_08_0021__p124123262386">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="iam_08_0021__p14412102614384">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="iam_08_0021__p1041214268381">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0021__row19412192611382"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_08_0021__p1341232613819">user_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_08_0021__p941292683812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_08_0021__p242423014138">User ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0021__row14121526193817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_08_0021__p741222614383">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_08_0021__p144121265387">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_08_0021__p941114010137">Indicates whether login protection has been enabled for the user. The value can be <strong id="iam_08_0021__b22451527529">true</strong> or <strong id="iam_08_0021__b19252175219525">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0021__row9412926163816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_08_0021__p164124263383">verification_method</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_08_0021__p84123262388">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_08_0021__p8411240121317">Login authentication method of the user. Options: <strong id="iam_08_0021__b73921646531">sms</strong>, <strong id="iam_08_0021__b33972412534">email</strong>, and <strong id="iam_08_0021__b193976435313">vmfa</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_08_0021__section11300926163818"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_08_0021__screen14412192653819">PUT https://sample.domain.com/v3.0/OS-USER/users/{user_id}/login-protect
|
|
{
|
|
"login_protect" : {
|
|
"enabled" : true,
|
|
"verification_method" : "vmfa"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="iam_08_0021__section1130262653820"><h4 class="sectiontitle">Example Response</h4><p id="iam_08_0021__p9950172165813"><strong id="iam_08_0021__b947417107535">Status code: 200</strong></p>
|
|
<p id="iam_08_0021__p14182917125911">The request is successful.</p>
|
|
<pre class="screen" id="iam_08_0021__screen59616426482">{
|
|
"login_protect" : {
|
|
"user_id": "16b26081f43d4c628c4bb88cf32e9...",
|
|
"enabled" : true,
|
|
"verification_method" : "vmfa"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="iam_08_0021__section1830292623813"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0021__table1930214265381" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_08_0021__row174121526153813"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="iam_08_0021__p11412202614386">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="iam_08_0021__p104121226133816">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_08_0021__row6412112611387"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0021__p631612369531">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0021__p143161363537">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0021__row1415616282535"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0021__p1231615362535">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0021__p53163363535">The request is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0021__row814090165411"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0021__p1652019501377">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0021__p552075016378">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0021__row19763163010531"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0021__p13165361534">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0021__p1131663635310">You do not have permission to perform this action.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0021__row121153295326"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0021__p5048894216138">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0021__p6307248716138">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_08_0021__row7763113075317"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0021__p12316336105313">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0021__p16316113612532">A system error occurred.</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>
|
|
|