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>
331 lines
22 KiB
HTML
331 lines
22 KiB
HTML
<a name="iam_02_0025"></a><a name="iam_02_0025"></a>
|
||
|
||
<h1 class="topictitle1">Modifying the Login Authentication Policy</h1>
|
||
<div id="body1597737539340"><div class="section" id="iam_02_0025__section1069020111206"><h4 class="sectiontitle">Function</h4><p id="iam_02_0025__p788819117209">This API is provided for the administrator to modify the login authentication policy.</p>
|
||
</div>
|
||
<div class="section" id="iam_02_0025__section26927122015"><h4 class="sectiontitle">URI</h4><p id="iam_02_0025__p888881162017">PUT /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/login-policy</p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0025__table969212118201" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="iam_02_0025__row388919152017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="iam_02_0025__p68896152017">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.2.3.2.5.1.2"><p id="iam_02_0025__p10889151172011">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="iam_02_0025__p178891813202">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.3.2.5.1.4"><p id="iam_02_0025__p68893192015">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="iam_02_0025__row11889911200"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_02_0025__p16889101162018">domain_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_02_0025__p1588916142013">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_02_0025__p10889519206">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_02_0025__p688912118209">Domain ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="iam_02_0025__section11699171142011"><h4 class="sectiontitle">Request Parameters</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0025__table14700119202" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_02_0025__row178896122016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_02_0025__p18891316204">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.5.1.2"><p id="iam_02_0025__p38892018208">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="iam_02_0025__p168893122014">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.5.1.4"><p id="iam_02_0025__p16889612203">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="iam_02_0025__row2088951112014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_02_0025__p13889011203">X-Auth-Token</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_02_0025__p288901142015">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_02_0025__p2889191102018">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_02_0025__p5889310203">Token with <strong id="iam_02_0025__b88821932174710">Security Administrator</strong> permissions.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0025__table57092110204" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request body</caption><thead align="left"><tr id="iam_02_0025__row108891317207"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="iam_02_0025__p1688918122016">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.3.2.5.1.2"><p id="iam_02_0025__p1688911152011">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="iam_02_0025__p688931172011">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.5.1.4"><p id="iam_02_0025__p28892172019">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="iam_02_0025__row58897116205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="iam_02_0025__p188899132017"><a href="#iam_02_0025__table1671401152018">login_policy</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="iam_02_0025__p1288961112014">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="iam_02_0025__p88898118203">object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="iam_02_0025__p28890120205">Login authentication policy.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="iam_02_0025__table1671401152018"></a><a name="table1671401152018"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0025__table1671401152018" frame="border" border="1" rules="all"><caption><b>Table 4 </b>login_policy</caption><thead align="left"><tr id="iam_02_0025__row138891411206"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="iam_02_0025__p388910102016">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.4.2.5.1.2"><p id="iam_02_0025__p18893132018">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="iam_02_0025__p68891114205">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.4.2.5.1.4"><p id="iam_02_0025__p78891619209">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="iam_02_0025__row1488911113204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_02_0025__p088911172011">account_validity_period</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_02_0025__p1535710515612">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_02_0025__p1748833113206">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_02_0025__p61728117201">Validity period (days) to disable users if they have not logged in within the period. Value range: 0–240. If this parameter is set to <strong id="iam_02_0025__b10272642162215">0</strong>, no users will be disabled.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row28892152011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_02_0025__p11889151152011">custom_info_for_login</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_02_0025__p10371755611">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_02_0025__p1949093172017">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_02_0025__p588914114208">Custom information that will be displayed upon successful login. </p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row14889516209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_02_0025__p688915102019">lockout_duration</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_02_0025__p10387052610">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_02_0025__p4491173118205">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_02_0025__p19889121182015">Duration (minutes) to lock users out. Value range: 15–30.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row78899192016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_02_0025__p1688917116207">login_failed_times</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_02_0025__p16390351865">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_02_0025__p19492193112208">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_02_0025__p58892013202">Number of unsuccessful login attempts to lock users out. Value range: 3–10.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row2889181192013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_02_0025__p98895152019">period_with_login_failures</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_02_0025__p113931951269">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_02_0025__p24933311209">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_02_0025__p1788916142017">Period (minutes) to count the number of unsuccessful login attempts. Value range: 15–60.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row128891218202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_02_0025__p19889111152013">session_timeout</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_02_0025__p19396457619">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_02_0025__p154955312203">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_02_0025__p14959318208">Session timeout (minutes) that will apply if you or users created using your account do not perform any operations within a specific period. Value range: 15–1440.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row588910116203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_02_0025__p388901122017">show_recent_login_info</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_02_0025__p339910518618">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_02_0025__p16496113142011">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_02_0025__p188981122016">Indicates whether to display last login information upon successful login. The value can be <strong id="iam_02_0025__b128318287485">true</strong> or <strong id="iam_02_0025__b3288928154818">false</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="iam_02_0025__section2073013152020"><h4 class="sectiontitle">Response Parameters</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0025__table107311117208" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters in the response body</caption><thead align="left"><tr id="iam_02_0025__row1688913162016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.1"><p id="iam_02_0025__p1088914115208">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.2"><p id="iam_02_0025__p108891312203">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.2.4.1.3"><p id="iam_02_0025__p68898117208">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="iam_02_0025__row1788913182020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="iam_02_0025__p11889111172019"><a href="#iam_02_0025__table157388112015">login_policy</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.2 "><p id="iam_02_0025__p1688916118205">object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.2.4.1.3 "><p id="iam_02_0025__p388911114201">Login authentication policy.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="iam_02_0025__table157388112015"></a><a name="table157388112015"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0025__table157388112015" frame="border" border="1" rules="all"><caption><b>Table 6 </b>login_policy</caption><thead align="left"><tr id="iam_02_0025__row58908112202"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="iam_02_0025__p15890131172011">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="iam_02_0025__p1789021192011">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="iam_02_0025__p4890714207">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="iam_02_0025__row58901613205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_02_0025__p189071152017">account_validity_period</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_02_0025__p1289017182015">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_02_0025__p15890718203">Validity period (days) to disable users if they have not logged in within the period.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row08903102012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_02_0025__p148901715209">custom_info_for_login</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_02_0025__p1389061132020">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_02_0025__p28907182018">Custom information that will be displayed upon successful login.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row3890131102014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_02_0025__p138901122014">lockout_duration</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_02_0025__p689010112201">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_02_0025__p198903182018">Duration (minutes) to lock users out.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row089014120204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_02_0025__p189021102016">login_failed_times</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_02_0025__p1789011112206">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_02_0025__p589051132011">Number of unsuccessful login attempts to lock users out.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row48906182014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_02_0025__p128901611200">period_with_login_failures</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_02_0025__p15890191172017">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_02_0025__p88902018203">Period (minutes) to count the number of unsuccessful login attempts.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row1689010182014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_02_0025__p158901810208">session_timeout</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_02_0025__p1189020111204">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_02_0025__p189010120204">Session timeout (minutes) that will apply if you or users created using your account do not perform any operations within a specific period.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row28903115200"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_02_0025__p28904122012">show_recent_login_info</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_02_0025__p16890191162019">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_02_0025__p889051192015">Indicates whether to display last login information upon successful login.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="iam_02_0025__section57491611202"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_02_0025__screen689012132019">PUT https://sample.domain.com/v3.0/OS-SECURITYPOLICY/domains/{domain_id}/login-policy
|
||
|
||
{
|
||
"login_policy" : {
|
||
"custom_info_for_login" : "",
|
||
"period_with_login_failures" : 15,
|
||
"lockout_duration" : 15,
|
||
"account_validity_period" : 99,
|
||
"login_failed_times" : 3,
|
||
"session_timeout" : 16,
|
||
"show_recent_login_info" : true
|
||
}
|
||
}</pre>
|
||
</div>
|
||
<div class="section" id="iam_02_0025__section675871142010"><h4 class="sectiontitle">Example Response</h4><p id="iam_02_0025__p98901182017"><strong id="iam_02_0025__b94551457165013">Status code: 200</strong></p>
|
||
<p id="iam_02_0025__p17890816205">The request is successful.</p>
|
||
<pre class="screen" id="iam_02_0025__screen198901116209">{
|
||
"login_policy" : {
|
||
"custom_info_for_login" : "",
|
||
"period_with_login_failures" : 15,
|
||
"lockout_duration" : 15,
|
||
"account_validity_period" : 99,
|
||
"login_failed_times" : 3,
|
||
"session_timeout" : 16,
|
||
"show_recent_login_info" : true
|
||
}
|
||
}</pre>
|
||
</div>
|
||
<p id="iam_02_0025__p9139124672214"><strong id="iam_02_0025__b1028859175018">Status code: 400</strong></p>
|
||
<p id="iam_02_0025__p31391746192214">The request body is abnormal.</p>
|
||
<ul id="iam_02_0025__ul313954613222"><li id="iam_02_0025__li4139646202210">Example 1</li></ul>
|
||
<pre class="screen" id="iam_02_0025__screen146261450192220">{
|
||
"error_msg" : "'%(key)s' is a required property.",
|
||
"error_code" : "IAM.0072"
|
||
}</pre>
|
||
<ul id="iam_02_0025__ul4813175122215"><li id="iam_02_0025__li081335119225">Example 2</li></ul>
|
||
<pre class="screen" id="iam_02_0025__screen11738558222">{
|
||
"error_msg" : "Invalid input for field '%(key)s'. The value is '%(value)s'.",
|
||
"error_code" : "IAM.0073"
|
||
}</pre>
|
||
<p id="iam_02_0025__p12139246102220"><strong id="iam_02_0025__b1981419265116">Status code: 403</strong></p>
|
||
<p id="iam_02_0025__p9139846112211">Access denied.</p>
|
||
<pre class="screen" id="iam_02_0025__screen1913984622211">{
|
||
"error_msg" : "You are not authorized to perform the requested action.",
|
||
"error_code" : "IAM.0002"
|
||
}</pre>
|
||
<p id="iam_02_0025__p613954602212"><strong id="iam_02_0025__b1932411518514">Status code: 500</strong></p>
|
||
<p id="iam_02_0025__p16139104614225">The system is abnormal.</p>
|
||
<pre class="screen" id="iam_02_0025__screen141391146162213">{
|
||
"error_msg" : "An unexpected error prevented the server from fulfilling your request.",
|
||
"error_code" : "IAM.0006"
|
||
}</pre>
|
||
<div class="section" id="iam_02_0025__section9777151172019"><h4 class="sectiontitle">Status Codes</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0025__table147781318201" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0025__row6890716208"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.19.2.1.3.1.1"><p id="iam_02_0025__p14890191172020">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_02_0025__p1890212209">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="iam_02_0025__row108904152013"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_02_0025__p1789015122019">200</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_02_0025__p148904122011">The request is successful.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row789081182019"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_02_0025__p1989018122010">400</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_02_0025__p389091172015">The request body is abnormal.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row68907111206"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_02_0025__p128905115207">401</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_02_0025__p689017172014">Authentication failed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row1389020118202"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_02_0025__p389014152012">403</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_02_0025__p889013142019">Access denied.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="iam_02_0025__row18890319209"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.19.2.1.3.1.1 "><p id="iam_02_0025__p108901614203">500</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.19.2.1.3.1.2 "><p id="iam_02_0025__p168909117209">The system is abnormal.</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>
|
||
|