vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/iam/api-ref/en-us_topic_0057845611.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

343 lines
31 KiB
HTML
Raw Blame History

<a name="en-us_topic_0057845611"></a><a name="en-us_topic_0057845611"></a>
<h1 class="topictitle1">Modifying User Information</h1>
<div id="body1492670576061"><div class="section" id="en-us_topic_0057845611__s5888597838b0425a92e3419fb766c7f5"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845611__p188361492056">This API is used to modify user information under a domain.</p>
</div>
<div class="section" id="en-us_topic_0057845611__s46d3616bd4c54e55ba97a528518a5890"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845611__en-us_topic_0026585112_ul20917673"><li id="en-us_topic_0057845611__l0762c927197248c39057087e143d6575">URI format<p id="en-us_topic_0057845611__p16330458113837"><a name="en-us_topic_0057845611__l0762c927197248c39057087e143d6575"></a><a name="l0762c927197248c39057087e143d6575"></a>PATCH /v3/users/{user_id}</p>
</li><li id="en-us_topic_0057845611__li32682147113817">URI parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845611__en-us_topic_0032920337_table29648085" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845611__en-us_topic_0032920337_row12693918"><th align="left" class="cellrowborder" valign="top" width="21.55%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="en-us_topic_0057845611__en-us_topic_0032920337_p21574462"><strong id="en-us_topic_0057845611__a6f95694edbbb43d8a152536754b86c82_1">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.55%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="en-us_topic_0057845611__en-us_topic_0032920337_p2701015"><strong id="en-us_topic_0057845611__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.81%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="en-us_topic_0057845611__en-us_topic_0032920337_p17455632"><strong id="en-us_topic_0057845611__b2102810915138_1">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="35.089999999999996%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="en-us_topic_0057845611__en-us_topic_0032920337_p4620049"><strong id="en-us_topic_0057845611__b13252891915133_1">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845611__en-us_topic_0032920337_row38679683"><td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__en-us_topic_0032920337_p46046605">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__en-us_topic_0032920337_p38787544">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.81%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__en-us_topic_0032920337_p54783372">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.089999999999996%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__en-us_topic_0032920337_p8268111">User ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845611__se7fe5cac0d544e119c49322cc1707eb6"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845611__en-us_topic_0026585112_ul3226198"><li id="en-us_topic_0057845611__l7c4919f55ea849a9bb59e1454113085c">Parameters in the request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845611__t68c7bd10e66a4380a1e6cdc78ca95669" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845611__r584496594a404ce18918a40e6e57c2ec"><th align="left" class="cellrowborder" valign="top" width="21.42%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845611__ac3a989cc5d3a405889eabb47dee84b04"><strong id="en-us_topic_0057845611__b20113712162014">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.55%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845611__a69a20ac00b86496aa8418517c542b0da"><strong id="en-us_topic_0057845611__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.81%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845611__a92c23d4441054df0972e025aeb3a8d7f"><strong id="en-us_topic_0057845611__b2102810915138_3">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="35.22%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845611__abe6882c44cf4402d8ed7706b9278f33b"><strong id="en-us_topic_0057845611__b13252891915133_3">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845611__r5d63069d6a8a426e8b25b94d1b4d302a"><td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845611__ad4fb6253385c46ab8720a0e13f573694">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845611__a6b33800bcb2a446695b1d33a2d751554">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.81%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845611__ab34a5e95b76b4b79a72da0734025f211">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.22%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845611__a716277ae541d4553bb10490f9c02593d">Fill <strong id="en-us_topic_0057845611__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__row29501427115257"><td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845611__p6637478211538">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="21.55%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845611__p764826811538">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.81%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845611__p1553001111538">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.22%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845611__p3577810173953">Authenticated token with the <strong id="en-us_topic_0057845611__b1384940419151417">Security Administrator</strong> permission.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845611__en-us_topic_0026585112_li29035785">Parameters in the request body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845611__en-us_topic_0026585112_table59995477" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845611__en-us_topic_0026585112_row14620943"><th align="left" class="cellrowborder" valign="top" width="21.42%" id="mcps1.3.3.2.2.1.1.5.1.1"><p id="en-us_topic_0057845611__en-us_topic_0026585112_p43445707"><strong id="en-us_topic_0057845611__a6f95694edbbb43d8a152536754b86c82_3">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.52%" id="mcps1.3.3.2.2.1.1.5.1.2"><p id="en-us_topic_0057845611__en-us_topic_0026585112_p29441404"><strong id="en-us_topic_0057845611__a105e6ed8c3de4c5a9dde97ae5a71071e_5">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.61%" id="mcps1.3.3.2.2.1.1.5.1.3"><p id="en-us_topic_0057845611__en-us_topic_0026585112_p35943562"><strong id="en-us_topic_0057845611__b2102810915138_5">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="35.449999999999996%" id="mcps1.3.3.2.2.1.1.5.1.4"><p id="en-us_topic_0057845611__en-us_topic_0026585112_p25747420"><strong id="en-us_topic_0057845611__b13252891915133_5">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845611__row6455613610239"><td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__p46361928102314">name</p>
</td>
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__p43240011102314">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.61%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__p28547939102314">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.449999999999996%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__p63231356193217">A username with 5 to 32 characters. The username can contain special characters, but only hyphens (-), underscores (_), and periods (.) are allowed. It cannot start with a digit.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__row37810320102744"><td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__p42737049102744">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__p39148906102744">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.61%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__p16944812102744">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.449999999999996%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__p30352518102744">ID of the domain where a user is located.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__row15919216102748"><td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__p14388120102748">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__p24587085102748">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.61%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__p45396854102748">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="35.449999999999996%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__p53266556102748">Enabling status of the user. <strong id="en-us_topic_0057845611__b18234347228">true</strong> indicates that the user is enabled. <strong id="en-us_topic_0057845611__b82351247222">false</strong> indicates that the user is disabled. The default value is <strong id="en-us_topic_0057845611__b1723654172212">true</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__row12436720103234"><td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__p741379103234">password</p>
</td>
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__p60051710103234">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.61%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__p32350346103234">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.449999999999996%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><div class="p" id="en-us_topic_0057845611__p16515794174222">User password after the change. The password must meet the following requirements:<ul id="en-us_topic_0057845611__ul62058101036"><li id="en-us_topic_0057845611__li558522971036">Can contain 6 to 32 characters. The system default minimum password length is 6 characters, and you can change the minimum password length.</li><li id="en-us_topic_0057845611__li277421951036">Must contain at least two of the following character types: uppercase letters, lowercase letters, digits, and special characters.</li><li id="en-us_topic_0057845611__li1223513894319">Cannot be the username or the username spelled backwards.</li><li id="en-us_topic_0057845611__li483531691036">Cannot contain the user's mobile phone number or email address.</li><li id="en-us_topic_0057845611__li325253421036">Must comply with the password policies under <strong id="en-us_topic_0057845611__b842352706162030">Account Settings</strong>.</li></ul>
</div>
</td>
</tr>
<tr id="en-us_topic_0057845611__row41415841161345"><td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__p38373798161347">default_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__p21269944161347">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.61%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__p45143927161347">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.449999999999996%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__p32779466161347">Default project ID of a user.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__row1889682916276"><td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__p3493194592314">description</p>
</td>
<td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__p1649374552312">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.61%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__p1049316456234">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.449999999999996%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__p134931945102313">Description of the user.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845611__en-us_topic_0026585112_li17042198">Example request<pre class="screen" id="en-us_topic_0057845611__s6b85ed1428f745fabd2d60e4481ee1db">1. Create the temporary file <em id="en-us_topic_0057845611__i975925214468">${filename}</em><strong id="en-us_topic_0057845611__b975985284610">.json</strong> based on the following template. <em id="en-us_topic_0057845611__i177592052184613">${filename} </em>indicates the temporary file name, which is user-defined.
{
"user": {
"name": "james1234",
"default_project_id": "88b16b6440684467b8825d7d96e154d8",
"enabled": false,
"password": "********"
}
}
2. Run the following command under the directory storing the <em id="en-us_topic_0057845611__i167491434132013">${filename}</em>.<strong id="en-us_topic_0057845611__b6749203420204">json</strong> file.
<em id="en-us_topic_0057845611__i07018383286">curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X POST -d @${filename}.json </em><em id="en-us_topic_0057845611__i9462655192816">https://sample.domain.com/v3/users/2c1c6c54e59141b889c99e6fada5f19f</em>
3. Run the following command under the directory of the <em id="en-us_topic_0057845611__i207618524463">${filename}</em><strong id="en-us_topic_0057845611__b147611052104617">.json</strong> file to delete the <em id="en-us_topic_0057845611__i1476125213463">${filename}</em><strong id="en-us_topic_0057845611__b117612523461">.json</strong> file.
<strong id="en-us_topic_0057845611__b1170123822815">rm</strong> <em id="en-us_topic_0057845611__i1370163812815">${filename}.json</em></pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845611__s3a08e13bb5b34dc2ba4dcd84a0d51cf5"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845611__u038cb568d63e46ac95f0986f79d7bc03"><li id="en-us_topic_0057845611__l2e0c2ec3fbf640ca9f98448f23594a13">Parameters in the response body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845611__t1266dd240c3649048c9f42af34a0686b" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845611__rd8ac2cd80e4b47d684b61df4f3c570cf"><th align="left" class="cellrowborder" valign="top" width="21.42%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845611__ad167d1bf89ca443eac693ea562da12a3"><strong id="en-us_topic_0057845611__a6f95694edbbb43d8a152536754b86c82_5">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.42%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845611__aad08ea1f8c8e4a42a1a81112a74cb237"><strong id="en-us_topic_0057845611__a105e6ed8c3de4c5a9dde97ae5a71071e_7">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.81%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845611__a9b5fafff0348408893dcc06fbe0b1186"><strong id="en-us_topic_0057845611__b2102810915138_7">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="35.35%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845611__ad002a0bf107a468884a5777e55f837f6"><strong id="en-us_topic_0057845611__b13252891915133_7">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845611__ref3b81e8e64e418c961ca1bce6f25280"><td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845611__abb2b4d81b907497da50ad4f12760f7dc">user</p>
</td>
<td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845611__a7e49a4eaca054e36ba774b0cdc492081">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.81%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845611__p334415561311">JSON object</p>
</td>
<td class="cellrowborder" valign="top" width="35.35%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845611__a8ded0409c6d948dc82f7f779a4cfa5b8">User object.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845611__l86920d09d4224a93a4379c10a51077f0">Description for the user format
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845611__t3ef10d134105438f922a72ac36adbe13" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845611__ra836795da3204436ad115c6d63f33cb3"><th align="left" class="cellrowborder" valign="top" width="21.240000000000002%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="en-us_topic_0057845611__a915f4fa2492a4fa3b5fc5b52cb975ed3"><strong id="en-us_topic_0057845611__a6f95694edbbb43d8a152536754b86c82_7">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.990000000000002%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="en-us_topic_0057845611__aeb29128c8bc6489593aaf12297635c52"><strong id="en-us_topic_0057845611__a105e6ed8c3de4c5a9dde97ae5a71071e_9">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.25%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="en-us_topic_0057845611__a367df15999ce47aa8fa2550bb2d3df9a"><strong id="en-us_topic_0057845611__b2102810915138_9">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="35.52%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="en-us_topic_0057845611__a16a6b7e4145e4fbabf25e75163ec3f95"><strong id="en-us_topic_0057845611__b13252891915133_9">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845611__rb2ba995189ec478eb5d1181d3bb7be1c"><td class="cellrowborder" valign="top" width="21.240000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__aa1005da54f2c4746ae99676d14ab012d">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__a6d0540b177e34775b18c670cf5cd46bc">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.25%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__a65f6a6fc5a364d868072c58eeab90325">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="35.52%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__ababe5d21d4764e209d225a4cea9b9fa2">Whether a user is enabled. The value can be <strong id="en-us_topic_0057845611__b18570608618403">true</strong> or <strong id="en-us_topic_0057845611__b65172625518403">false</strong>. <strong id="en-us_topic_0057845611__b127154530118403">true</strong> indicates the user is enabled and <strong id="en-us_topic_0057845611__b173784535818403">false</strong> indicates the user is not enabled. The default value is <strong id="en-us_topic_0057845611__b842352706184016">true</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__r41522dc2bd8d475b8d2a16af17d5213b"><td class="cellrowborder" valign="top" width="21.240000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__a2501c5b12ff94e338c0930e6c321af90">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__af10224f581d946cb91a49683adf34271">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.25%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__a0316e95fb756489a82f70ae562c523b4">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.52%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__af5ce8c5c520f468895f28d74f6eb4540">User ID.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__r1208cbb1496440d89eb758b2cd80d578"><td class="cellrowborder" valign="top" width="21.240000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__a4504807eb899465fb0ce3ac82d7013dc">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__en-us_topic_0026585113_p386591205643">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.25%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__a293aacc9b5354786a8b30a063a186b02">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.52%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__aa1138dcdd40340039e621e7abf0332e1">ID of the domain where a user is located.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__rbe8775b4e77a4b08be093de05e7bcbf3"><td class="cellrowborder" valign="top" width="21.240000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__acc4c499e1b2f4bdd98e5c7acd4e8861b">name</p>
</td>
<td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__a4bf5dfe715d342e0a883343cbcf8181a">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.25%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__a8c424bac7d93444dbc647a1d5c5c21e4">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.52%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__afc48731c8a2e4c66a56ac245f7a1e34e">Username.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__row884150412952"><td class="cellrowborder" valign="top" width="21.240000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__p4507320312952">links</p>
</td>
<td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__p2705079812952">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.25%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__p1976144517110">JSON object</p>
</td>
<td class="cellrowborder" valign="top" width="35.52%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__p4445286212952">User resource link.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__row384653784818"><td class="cellrowborder" valign="top" width="21.240000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__p108471237134816">description</p>
</td>
<td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__p684753712481">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.25%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__p20847637114813">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.52%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__p16974746194818">Description of the user.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__row451303512957"><td class="cellrowborder" valign="top" width="21.240000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__p3001154112957">default_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__p1501577612957">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.25%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__p831835612957">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.52%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__p269819912957">Default project ID of a user.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__row720485320451"><td class="cellrowborder" valign="top" width="21.240000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845611__p4356239920454">password_expires_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845611__p3889339420454">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.25%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845611__p6335724720454">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.52%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845611__p3166337220454">UTC when the password will expire. <strong id="en-us_topic_0057845611__b66701129328">null</strong> indicates that the password will not expire.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0057845611__en-us_topic_0026585112_ul10497152"><li id="en-us_topic_0057845611__lf3c28402a2ee4844bc99946ea67bf82d">Example response<pre class="screen" id="en-us_topic_0057845611__sf943dd4d83494c55a12db23ebfa9eb99">{
"user": {
"name": "james1234",
"links": {
"self": "https://sample.domain.com/v3/users/6d8b04e3bf99445b8f76300903e5bf32"
},
"description": {
},
"domain_id": "88b16b6440684467b8825d7d96e154d8",
"enabled": false,
"id": "6d8b04e3bf99445b8f76300903e5bf32",
"default_project_id": "88b16b6440684467b8825d7d96e154d8",
"password_expires_at": "2016-12-07T00:00:00.000000Z"
}
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845611__sbfe93ca4c2b9427dbb2218a4e72da6a8"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845611__en-us_topic_0035544336_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845611__en-us_topic_0035544336_row10578662"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845611__en-us_topic_0035544336_p51565323"><strong id="en-us_topic_0057845611__b842352706104328">Status Code</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.2"><p id="en-us_topic_0057845611__en-us_topic_0035544336_p16041657"><strong id="en-us_topic_0057845611__b13252891915133_11">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845611__en-us_topic_0035544336_row24305815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845611__en-us_topic_0035544336_p22613965">200</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845611__en-us_topic_0035544336_p19791876">The request is successful.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__en-us_topic_0035544336_row43909159"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845611__en-us_topic_0035544336_p66980994">400</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845611__en-us_topic_0035544336_p56751409">The server failed to process the request.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__rb99fbab78bc54ae4953661763b573830"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845611__aef55745ff0834933af36d690e2e339b8">401</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845611__a480215738ced4bf5a8feafa2681db93b">Authentication failed.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__en-us_topic_0035544336_row41000636"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845611__en-us_topic_0035544336_p32717189">403</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845611__ae678037f26d640f5a985c943e2ffb92e">Access denied.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__r1fd5c05b7b6b4c048f3f7b9ddbc755b0"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845611__a5d7e2305922e4f9098442a900792dae1">404</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845611__a9edf299d0513460caaac8a2a19b76e9a">The requested resource cannot be found.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__rbb5133f150fd42eebde8dd6e390ecbd5"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845611__ad1a2754016e44193a97043265cd611cf">405</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845611__a81837d461ef445259c5a6e9e1ce0e32a">The method specified in the request is not allowed for the requested resource.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__row54458900174727"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845611__p38616014174730">409</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845611__p40889433174730">A resource conflict occurs.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__r2cecff297b1a412f956a312d3cd7acc9"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845611__a1f617621d1bc4a9facb1c84d1946002b">413</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845611__ac31ead3ee2db40eea8ae45b2779a09e9">The request entity is too large.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__rd71e0e00759f4179a2dccaf345ba9f2f"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845611__a1657c5ca5ebd4a2cbacbdb35fc9b7601">500</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845611__a88b4b14048564e12942b8151dc791b99">Internal server error.</p>
</td>
</tr>
<tr id="en-us_topic_0057845611__r5647e5fd26974514ac66cc3925f30601"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845611__a16dfaa16ceac4a33a468c0ae158292fb">503</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845611__a5635c1924d9648a8be89b1e5dcf0a87b">Service unavailable.</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