youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/iam/api-ref/iam_08_0011.html
Wei, Hongmin 80f18fd272 IAM API 2.6 Version 
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>
2023-08-03 03:34:59 +00:00

582 lines
57 KiB
HTML
Raw Blame History

<a name="iam_08_0011"></a><a name="iam_08_0011"></a>
<h1 class="topictitle1">Modifying User Information (Including Email Address and Mobile Number) as the Administrator</h1>
<div id="body8662426"><div class="section" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_section13155155913310"><h4 class="sectiontitle">Function</h4><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p11162125903111">This API is provided for the administrator to modify user information.</p>
</div>
<div class="section" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_section111801059193111"><h4 class="sectiontitle">URI</h4><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p131871259163120">PUT /v3.0/OS-USER/users/{user_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_table919325911315" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row9191959103110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p16196105915314">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.2.3.2.5.1.2"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p18202145953120">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p15208185953110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.3.2.5.1.4"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p12217115973111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1919113592310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p11222105910318">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p14226115913113">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1023275911313">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p32391559143119">User ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_section13247135953113"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1625917593318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p6267165943111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p427285913314">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.5.1.3"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1727765910315">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_0011__en-us_topic_0221572541_en-us_topic_0221482439_p92822595319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row13260859193110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p182871459183117">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1129175933111">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p129875915319">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p16303159163113">Fill <strong id="iam_08_0011__en-us_topic_0221572541_b1224313538532">application/json;charset=utf8</strong> in this field.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row11260115973117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p73101259153116">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p113151859113118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p33201859173118">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p632725918311">Token with <strong id="iam_08_0011__b032914344564">Security Administrator</strong> permissions.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_requestParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request body</caption><thead align="left"><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row163321759113120"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1033965915314">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.3.2.5.1.2"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p123454598318">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1835214598314">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.5.1.4"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p18359559123115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row633220596312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p14364105943111"><a href="#iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_request_Rq810User">user</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1368195917311">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1437515912313">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p9380195918312">IAM user information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_request_Rq810User"></a><a name="en-us_topic_0221572541_en-us_topic_0221482439_request_Rq810User"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_request_Rq810User" frame="border" border="1" rules="all"><caption><b>Table 4 </b>user</caption><thead align="left"><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row163841598315"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.3.4.2.5.1.1"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p43911459113113">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="9.950000000000001%" id="mcps1.3.3.4.2.5.1.2"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1239575963111">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p7400159143112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.4.2.5.1.4"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p4406165912313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row173841459123110"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p18410195919314">name</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p441475923118">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1242085914313">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0195430251_p279630593745">New username with 1 to 255 characters</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row83841859133112"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p12429959113118">password</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p13435195993117">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p144401759103111">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1144510594314">Password of the user. The password must meet the following requirements:</p>
<ul id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_ul14452559183112"><li id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_li12454159123115">Can contain 6 to 32 characters. The default minimum password length is 6 characters.</li><li id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_li184582059143110">Must contain at least two of the following character types: uppercase letters, lowercase letters, digits, and special characters.</li><li id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_li647115917314">Must meet the requirements of the password policy configured on the account settings page.</li><li id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_li4478195963113">Must be different from the old password.</li></ul>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row11384145913316"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p7485759203119">email</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p2490115993113">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p249805917313">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p5502145963118">Email address, which can contain not more than 255 characters.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row2038419595315"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1250635917319">areacode</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1051165919314">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p751685993111">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1952115590315">Country code. The country code must be used together with a mobile number.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row63851659143117"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p12528359143110">phone</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p353445915310">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p115392597317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p55491159183118">New mobile number, which can contain a maximum of 32 digits. The mobile number must be used together with a country code.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1238511594317"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p25536599319">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p65631559143112">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1256885983116">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p857419591310">Enabling status of the IAM user. <strong id="iam_08_0011__b2976163115575">true</strong> (default value) indicates that the user is enabled. <strong id="iam_08_0011__b18983163116576">false</strong> indicates that the user is disabled.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row038555973118"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p158065963117">pwd_status</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p75851859123120">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p45951859123116">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0011__p19731545673">Indicates whether the user must change their password at the first login. <strong id="iam_08_0011__b12561946155819">true</strong> (default value) indicates that the user must change their password at the first login. <strong id="iam_08_0011__b16354112575918">false</strong> indicates that the user does not need to change their password at the first login.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row938515597315"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p4612135903117">xuser_type</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p196179596318">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p962514596313">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1663125916315">Type of the user in the external system. The user type can contain a maximum of 64 characters. <strong id="iam_08_0011__en-us_topic_0221572541_b103205245811">xuser_type</strong> must be used together with <strong id="iam_08_0011__en-us_topic_0221572541_b1932114241089">xuser_id</strong> and will be verified based on <strong id="iam_08_0011__en-us_topic_0221572541_b5321182419814">xaccount_type</strong> and <strong id="iam_08_0011__en-us_topic_0221572541_b1332292419818">xdomain_type</strong> of the same account.</p>
<div class="note" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_note186423592315"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p3648259163114">An external system refers to an enterprise management system connected to cloud system. Parameters <strong id="iam_08_0011__b8364123123614">xaccount_type</strong>, <strong id="iam_08_0011__b143709312365">xaccount_id</strong>, <strong id="iam_08_0011__b1537033203615">xdomain_type</strong>, <strong id="iam_08_0011__b137015383614">xdomain_id</strong>, <strong id="iam_08_0011__b8370133133612">xuser_type</strong>, and <strong id="iam_08_0011__b53701315364">xuser_id</strong> cannot be obtained from the cloud system. Please contact the enterprise administrator.</p>
</div></div>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row2038565917314"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p76530598319">xuser_id</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p14658175973110">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p566315919317">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1066816599315">ID of the user in the external system. The user ID can contain a maximum of 128 characters, and must be used together with <strong id="iam_08_0011__en-us_topic_0221572541_b2041016299810">xuser_type</strong>.</p>
<div class="note" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_note1467865916315"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="iam_08_0011__p1248815314510">An external system refers to an enterprise management system connected to cloud system. Parameters <strong id="iam_08_0011__b174351345193615">xaccount_type</strong>, <strong id="iam_08_0011__b443644553613">xaccount_id</strong>, <strong id="iam_08_0011__b743718452365">xdomain_type</strong>, <strong id="iam_08_0011__b8438134520365">xdomain_id</strong>, <strong id="iam_08_0011__b14439945133614">xuser_type</strong>, and <strong id="iam_08_0011__b13440945193614">xuser_id</strong> cannot be obtained from the cloud system. Please contact the enterprise administrator.</p>
</div></div>
</td>
</tr>
<tr id="iam_08_0011__row1992411412716"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0011__p1159811161273">access_mode</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0011__p209241141176">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0011__p1492410147711">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0011__p859819167713">Access type of the IAM user.</p>
<ul id="iam_08_0011__ul15221327985"><li id="iam_08_0011__li3221627182"><strong id="iam_08_0011__b2071485262911">default</strong>: programmatic access and management console access. This option is the default access type.</li><li id="iam_08_0011__li82211727886"><strong id="iam_08_0011__b484155417299">programmatic</strong>: programmatic access</li><li id="iam_08_0011__li822110279819"><strong id="iam_08_0011__b1647295612910">console</strong>: management console access</li></ul>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1238525913319"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p8688959153111">description</p>
</td>
<td class="cellrowborder" valign="top" width="9.950000000000001%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p9693559113119">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p2697559173114">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p57011859103114">Description of the IAM user.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_section7708135983114"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_responseParameter" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters in the response body</caption><thead align="left"><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row971685953114"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.1"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p37224590319">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_0011__en-us_topic_0221572541_en-us_topic_0221482439_p87272590314">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_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1373185912310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row671611594311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p197351159123110"><a href="#iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_response_Rs810User">user</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p117401459143114">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p6744359193116">IAM user information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_response_Rs810User"></a><a name="en-us_topic_0221572541_en-us_topic_0221482439_response_Rs810User"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_response_Rs810User" frame="border" border="1" rules="all"><caption><b>Table 6 </b>user</caption><thead align="left"><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1974825933119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p575335913311">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_0011__en-us_topic_0221572541_en-us_topic_0221482439_p6757135963113">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_0011__en-us_topic_0221572541_en-us_topic_0221482439_p0762059123118">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row07484596312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1076615993116">pwd_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p157701459123120">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p4776959203115">Whether password reset is required at first login.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row19748135933114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p17781105953113">xuser_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p15785125917312">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p137901159123119">ID of the user in the external system.</p>
<div class="note" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_note0801115916318"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="iam_08_0011__p152842111958">An external system refers to an enterprise management system connected to cloud system. Parameters <strong id="iam_08_0011__b19851248133612">xaccount_type</strong>, <strong id="iam_08_0011__b498664813617">xaccount_id</strong>, <strong id="iam_08_0011__b109873484369">xdomain_type</strong>, <strong id="iam_08_0011__b4988144818369">xdomain_id</strong>, <strong id="iam_08_0011__b99891948133616">xuser_type</strong>, and <strong id="iam_08_0011__b299013483360">xuser_id</strong> cannot be obtained from the cloud system. Please contact the enterprise administrator.</p>
</div></div>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1748185912319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1081245973117">xuser_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p4817175919312">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p982155993119">Type of the user in the external system.</p>
<div class="note" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_note28311259183118"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="iam_08_0011__p6641322515">An external system refers to an enterprise management system connected to cloud system. Parameters <strong id="iam_08_0011__b1788115293613">xaccount_type</strong>, <strong id="iam_08_0011__b989152143611">xaccount_id</strong>, <strong id="iam_08_0011__b39017521364">xdomain_type</strong>, <strong id="iam_08_0011__b10911052123614">xdomain_id</strong>, <strong id="iam_08_0011__b11921524364">xuser_type</strong>, and <strong id="iam_08_0011__b19335210360">xuser_id</strong> cannot be obtained from the cloud system. Please contact the enterprise administrator.</p>
</div></div>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row174885993119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p084125912310">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p19846195916315">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p2085195918319">Description of the IAM user.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1474814598317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1185725918312">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p13863105903117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p9868155983117">New IAM user name with 5 to 32 characters. The username can contain special characters, but only hyphens (-), underscores (_), and spaces are allowed. It cannot start with a digit.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row77481559103112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1487410591318">phone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p487975910314">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p78841559123119">New mobile number, which can contain a maximum of 32 digits. The mobile number must be used together with a country code.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row10748205933116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p48911859133114">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1989685983114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p490175913318">ID of the account to which the user belongs.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row18748959143119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p169064595314">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p491115973115">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p29161459133112">Enabling status of the IAM user. <strong id="iam_08_0011__b584944715915">true</strong> (default value) indicates that the user is enabled. <strong id="iam_08_0011__b17856184714598">false</strong> indicates that the user is disabled.</p>
</td>
</tr>
<tr id="iam_08_0011__row1048891814911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__p146458496916">pwd_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__p193170564911">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__p86450491993">Indicates whether the user must change their password at the first login. <strong id="iam_08_0011__b1167174316594">true</strong> (default value) indicates that the user must change their password at the first login. <strong id="iam_08_0011__b26734320594">false</strong> indicates that the user does not need to change their password at the first login.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1874925913112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p179221759163118">areacode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p17927165911319">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p18932205943113">Country code.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row574965933120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p179373592312">email</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p994219592310">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p09471659173113">New email address.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1774935915310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p69681659103119">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p297325914317">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1981105933112">IAM user ID.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1474920593315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p49864596319"><a href="#iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_response_Rs810UserLinks">links</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1699215915314">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p6999145918312">User resource link information.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row167492591310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p14518093220">password_expires_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p191019093212">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p4164010324">UTC time when the password will expire. <strong id="iam_08_0011__en-us_topic_0221572541_b01706328213">null</strong> indicates that the password has unlimited validity.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_response_Rs810UserLinks"></a><a name="en-us_topic_0221572541_en-us_topic_0221482439_response_Rs810UserLinks"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_response_Rs810UserLinks" frame="border" border="1" rules="all"><caption><b>Table 7 </b>user.links</caption><thead align="left"><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row421709327"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p10280014329">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_0011__en-us_topic_0221572541_en-us_topic_0221482439_p4336073210">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_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1439150173213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row92115018324"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p12453018321">self</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p11504016328">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p105517063210">Resource link.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_section206020203212"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_screen1087404875910">PUT https://sample.domain.com/v3.0/OS-USER/users/{user_id}</pre>
<pre class="screen" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_screen2771053219">{
"user": {
"email": "IAMEmail@123.com",
"areacode": "0086",
"phone": "12345678910",
"enabled": true,
"name": "IAMUser",
"password": "IAMPassword@",
"pwd_status": false,
"xuser_type": "",
"xuser_id": "",
"description": "IAMDescription"
}
}</pre>
</div>
<div class="section" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_section41351204327"><h4 class="sectiontitle">Example Response</h4><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p7140605326"><strong id="iam_08_0011__en-us_topic_0221572541_b87712561917">Status code: 200</strong></p>
<p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p3144401326">The request is successful.</p>
<pre class="screen" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_screen51602012323">{
"user": {
"description": "IAMDescription",
"areacode": "0086",
"enabled": true,
"pwd_status": false,
"xuser_id": "",
"domain_id": "d78cbac186b744899480f25bd0...",
"phone": "12345678910",
"name": "IAMUser",
"links": {
"self": "https://sample.domain.com/3.0/OS-USER/users/076934ff9f0010cd1f0bc003..."
},
"id": "076934ff9f0010cd1f0bc0031019...",
"xuser_type": "",
"email": "IAMEmail@123.com"
}
}</pre>
</div>
<div class="section" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_section458718019321"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_table2444" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row152312093215"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p459116018325">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_0011__en-us_topic_0221572541_en-us_topic_0221482439_p959640163215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row823111017320"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p12598170163210">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p55991508324">The request is successful.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1232160153212"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p18601502323">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p136033033210">The server failed to process the request.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row142328016321"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1660612016321">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1460810053215">Authentication failed.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1923210113211"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p176101103324">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1161270203213">Access denied.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1123210023210"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p661480103215">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p19616180173213">The requested resource cannot be found.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row9232130173214"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p206183013213">405</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p4620109329">The method specified in the request is not allowed for the requested resource.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row6232160173219"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p196221023212">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1162413063211">A resource conflict occurs.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row623218033214"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p186263083212">413</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p462717016325">The request entity is too large.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row11232110113212"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p196293010324">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p763111053212">Internal server error.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row2232209329"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p166332013214">503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1063514014320">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_section176379013214"><h4 class="sectiontitle">Error Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_table2445" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row11291190203220"><th align="left" class="cellrowborder" valign="top" width="27.27272727272727%" id="mcps1.3.8.2.1.4.1.1"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p6641809320">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.36363636363636%" id="mcps1.3.8.2.1.4.1.2"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p564312017328">Error Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.36363636363636%" id="mcps1.3.8.2.1.4.1.3"><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p176447012324">Error Message</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row112911309323"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p66501303322">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1865220143216">1100</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p4654707327">Mandatory parameters are missing.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1429119015329"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p156601103324">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1566290133216">1101</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p36647073212">Invalid username.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row62914017324"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p11670705321">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p46726018328">1102</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p206741005321">Invalid email address.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row029170183215"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p76797073211">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p126818018328">1103</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p116831309326">Incorrect password.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1129140163211"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p18689707324">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p969116053214">1104</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p16693909328">Invalid mobile number.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row729119013322"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p969814019329">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p17701100173218">1105</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p13703190103214">The value of <strong id="iam_08_0011__en-us_topic_0221572541_b783615317108">xuser_type</strong> must be the same as that of <strong id="iam_08_0011__en-us_topic_0221572541_b4837853131012">xdomain_type</strong>.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row15291160123218"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p177081208324">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p14710180123218">1106</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p471130163211">The country code and mobile number must be set at the same time.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row1229116014327"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p6717302324">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p57196018326">1107</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p18720120163220">The account administrator cannot be deleted.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row129116083215"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p67251606328">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1727106326">1108</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p147299018321">The new password must be different from the old password.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row16292190133214"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p67349003214">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p15735110163213">1109</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p15737301321">The username already exists.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row42921015325"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p11742150113212">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p147452018328">1110</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1874750133215">The email address has already been used.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row192921604322"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p175213013211">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p7753190193216">1111</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p1575520103216">The mobile number has already been used.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row152921309329"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p67613093213">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p17763309327">1113</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p17765190143216">The user ID or user type already exists.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row172922010323"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p277020123214">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p5773307327">1115</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p577520016321">The number of IAM users has reached the maximum allowed limit.</p>
</td>
</tr>
<tr id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_row229218043218"><td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.8.2.1.4.1.1 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p147832073211">400</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.2 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p178520017323">1117</p>
</td>
<td class="cellrowborder" valign="top" width="36.36363636363636%" headers="mcps1.3.8.2.1.4.1.3 "><p id="iam_08_0011__en-us_topic_0221572541_en-us_topic_0221482439_p11787200123213">Invalid user description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845593.html">User Management</a></div>
</div>
</div>
View Git Blame Copy Permalink