forked from docs/doc-exports
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>
334 lines
29 KiB
HTML
334 lines
29 KiB
HTML
<a name="en-us_topic_0057845637"></a><a name="en-us_topic_0057845637"></a>
|
|
|
|
<h1 class="topictitle1">Creating a User</h1>
|
|
<div id="body1492670576057"><div class="section" id="en-us_topic_0057845637__s5888597838b0425a92e3419fb766c7f5"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845637__p1430513291641">This API is used to create a user under a domain.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845637__s46d3616bd4c54e55ba97a528518a5890"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0057845637__add094e444a964580808e4d1bdb27f0d0">POST /v3/users</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845637__se7fe5cac0d544e119c49322cc1707eb6"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845637__en-us_topic_0026585112_ul3226198"><li id="en-us_topic_0057845637__l7c4919f55ea849a9bb59e1454113085c">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845637__t68c7bd10e66a4380a1e6cdc78ca95669" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845637__r584496594a404ce18918a40e6e57c2ec"><th align="left" class="cellrowborder" valign="top" width="21.95%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845637__ac3a989cc5d3a405889eabb47dee84b04"><strong id="en-us_topic_0057845637__a6f95694edbbb43d8a152536754b86c82_1">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.75%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845637__a69a20ac00b86496aa8418517c542b0da"><strong id="en-us_topic_0057845637__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.169999999999998%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845637__a92c23d4441054df0972e025aeb3a8d7f"><strong id="en-us_topic_0057845637__a703d34a49a2f4162bc1a1a439f655f95_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37.13%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845637__abe6882c44cf4402d8ed7706b9278f33b"><strong id="en-us_topic_0057845637__b842352706114032_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845637__r5d63069d6a8a426e8b25b94d1b4d302a"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845637__ad4fb6253385c46ab8720a0e13f573694">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.75%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845637__a6b33800bcb2a446695b1d33a2d751554">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845637__ab34a5e95b76b4b79a72da0734025f211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.13%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845637__a716277ae541d4553bb10490f9c02593d">Fill <strong id="en-us_topic_0057845637__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__row29501427115257"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845637__p6637478211538">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.75%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845637__p764826811538">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845637__p1553001111538">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.13%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845637__p53757920173238">Authenticated token with the <strong id="en-us_topic_0057845637__b750798910387">Security Administrator</strong> permission.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845637__en-us_topic_0026585112_li29035785">Parameters in the request body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845637__table1969814565514" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Description for the user format</caption><thead align="left"><tr id="en-us_topic_0057845637__row1269854535512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.1.2.5.1.1"><p id="en-us_topic_0057845637__p7697945145512"><strong id="en-us_topic_0057845637__a6f95694edbbb43d8a152536754b86c82_5">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.1.2.5.1.2"><p id="en-us_topic_0057845637__p869715458554">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.1.2.5.1.3"><p id="en-us_topic_0057845637__p1769724525513">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.1.2.5.1.4"><p id="en-us_topic_0057845637__p4698245135519">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845637__row136989451552"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.2.5.1.1 "><p id="en-us_topic_0057845637__p469894517553"><a href="#en-us_topic_0057845637__table470015453550">user</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.1.2.5.1.2 "><p id="en-us_topic_0057845637__p269894517558">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.2.5.1.3 "><p id="en-us_topic_0057845637__p7698114535518">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.1.2.5.1.4 "><p id="en-us_topic_0057845637__p1369864514556">User information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0057845637__table470015453550"></a><a name="table470015453550"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845637__table470015453550" frame="border" border="1" rules="all"><caption><b>Table 2 </b>user</caption><thead align="left"><tr id="en-us_topic_0057845637__row10698104545514"><th align="left" class="cellrowborder" valign="top" width="22.13%" id="mcps1.3.3.2.2.2.2.5.1.1"><p id="en-us_topic_0057845637__p1698104515518">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.71%" id="mcps1.3.3.2.2.2.2.5.1.2"><p id="en-us_topic_0057845637__p1698104565513"><strong id="en-us_topic_0057845637__b1410409398">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.78%" id="mcps1.3.3.2.2.2.2.5.1.3"><p id="en-us_topic_0057845637__p18698194518557"><strong id="en-us_topic_0057845637__b1115380048">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37.38%" id="mcps1.3.3.2.2.2.2.5.1.4"><p id="en-us_topic_0057845637__p26981245115512"><strong id="en-us_topic_0057845637__b111517773914474">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845637__row16698104515550"><td class="cellrowborder" valign="top" width="22.13%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="en-us_topic_0057845637__p369818458554">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.71%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="en-us_topic_0057845637__p8698445115515">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.78%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="en-us_topic_0057845637__p17698345125516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="en-us_topic_0057845637__p1569894512554">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_0057845637__row106989459550"><td class="cellrowborder" valign="top" width="22.13%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="en-us_topic_0057845637__p15698134565513">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.71%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="en-us_topic_0057845637__p369813453559">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.78%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="en-us_topic_0057845637__p36981945105514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="en-us_topic_0057845637__p19698124510556">ID of the domain where a user is located.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__row86992459553"><td class="cellrowborder" valign="top" width="22.13%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="en-us_topic_0057845637__p156989452555">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.71%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="en-us_topic_0057845637__p1769934535512">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.78%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="en-us_topic_0057845637__p8699134518556">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="en-us_topic_0057845637__p66997456558">Whether a user is enabled.</p>
|
|
<p id="en-us_topic_0057845637__p86998456553">The value can be <strong id="en-us_topic_0057845637__b18570608618403">true</strong> or <strong id="en-us_topic_0057845637__b65172625518403">false</strong>. <strong id="en-us_topic_0057845637__b127154530118403">true</strong> indicates the user is enabled and <strong id="en-us_topic_0057845637__b173784535818403">false</strong> indicates the user is not enabled. The default value is <strong id="en-us_topic_0057845637__b842352706184016">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__row156991245115510"><td class="cellrowborder" valign="top" width="22.13%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="en-us_topic_0057845637__p1569954535516">password</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.71%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="en-us_topic_0057845637__p86991745125515">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.78%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="en-us_topic_0057845637__p669924517556">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><div class="p" id="en-us_topic_0057845637__p18699154595515">Password of the user. The password must meet the following requirements:<ul id="en-us_topic_0057845637__ul4699184514558"><li id="en-us_topic_0057845637__li12699045195514">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_0057845637__li13699194585519">Must contain at least two of the following character types: uppercase letters, lowercase letters, digits, and special characters.</li><li id="en-us_topic_0057845637__li166991452558">Cannot be the username or the username spelled backwards.</li><li id="en-us_topic_0057845637__li36998453559">Cannot contain the user's mobile phone number or email address.</li><li id="en-us_topic_0057845637__li3699104575520">Must comply with the password policies under <strong id="en-us_topic_0057845637__b842352706162030">Account Settings</strong>.</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__row126997457551"><td class="cellrowborder" valign="top" width="22.13%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="en-us_topic_0057845637__p3699124520552">default_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.71%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="en-us_topic_0057845637__p16991945175513">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.78%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="en-us_topic_0057845637__p16699154517559">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="en-us_topic_0057845637__p96999457552">Default project ID of a user.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__row96992453558"><td class="cellrowborder" valign="top" width="22.13%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="en-us_topic_0057845637__p269974512559">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.71%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="en-us_topic_0057845637__p7699645105513">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.78%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="en-us_topic_0057845637__p56998457552">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.38%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="en-us_topic_0057845637__p166991445195517">Description of the user.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845637__en-us_topic_0026585112_li17042198">Example request<pre class="screen" id="en-us_topic_0057845637__s6b85ed1428f745fabd2d60e4481ee1db">1. Create the temporary file <em id="en-us_topic_0057845637__i8727154034518">${filename}</em><strong id="en-us_topic_0057845637__b97279402458">.json</strong> based on the following template. <em id="en-us_topic_0057845637__i9727640204515">${filename}</em> indicates the temporary file name, which is user-defined.
|
|
{
|
|
"user": {
|
|
"default_project_id": "acf2ffabba974fae8f30378ffde2cfa6",
|
|
"domain_id": "88b16b6440684467b8825d7d96e154d8",
|
|
"enabled": true,
|
|
"name": "jamesdoe",
|
|
"password": "********"
|
|
}
|
|
}
|
|
2. Run the following command under the directory storing the <em id="en-us_topic_0057845637__i20727144012459">${filename}</em>.<strong id="en-us_topic_0057845637__b472718403453">json</strong> file.
|
|
<em id="en-us_topic_0057845637__i1861516017477">curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X POST -d @${filename}.json https://sample.domain.com/v3/users</em>
|
|
3. Run the following command under the directory of the <em id="en-us_topic_0057845637__i67283403457">${filename}</em><strong id="en-us_topic_0057845637__b1972854014454">.json</strong> file to delete the <em id="en-us_topic_0057845637__i1728740154510">${filename}</em><strong id="en-us_topic_0057845637__b157281240134512">.json</strong> file.
|
|
<strong id="en-us_topic_0057845637__b18776175218263">rm</strong> <em id="en-us_topic_0057845637__i147763528269">${filename}.json</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845637__s3a08e13bb5b34dc2ba4dcd84a0d51cf5"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845637__u038cb568d63e46ac95f0986f79d7bc03"><li id="en-us_topic_0057845637__l2e0c2ec3fbf640ca9f98448f23594a13">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845637__t1266dd240c3649048c9f42af34a0686b" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845637__rd8ac2cd80e4b47d684b61df4f3c570cf"><th align="left" class="cellrowborder" valign="top" width="22.08%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845637__ad167d1bf89ca443eac693ea562da12a3"><strong id="en-us_topic_0057845637__a6f95694edbbb43d8a152536754b86c82_3">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.77%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845637__aad08ea1f8c8e4a42a1a81112a74cb237"><strong id="en-us_topic_0057845637__a105e6ed8c3de4c5a9dde97ae5a71071e_5">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.01%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845637__a9b5fafff0348408893dcc06fbe0b1186"><strong id="en-us_topic_0057845637__a703d34a49a2f4162bc1a1a439f655f95_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37.14%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845637__ad002a0bf107a468884a5777e55f837f6"><strong id="en-us_topic_0057845637__b842352706114032_3">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845637__ref3b81e8e64e418c961ca1bce6f25280"><td class="cellrowborder" valign="top" width="22.08%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845637__abb2b4d81b907497da50ad4f12760f7dc">user</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.77%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845637__a7e49a4eaca054e36ba774b0cdc492081">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.01%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845637__p1527211816218">JSON object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.14%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845637__a8ded0409c6d948dc82f7f779a4cfa5b8">User object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845637__l86920d09d4224a93a4379c10a51077f0">Description for the user format
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845637__t3ef10d134105438f922a72ac36adbe13" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845637__ra836795da3204436ad115c6d63f33cb3"><th align="left" class="cellrowborder" valign="top" width="21.95%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="en-us_topic_0057845637__a915f4fa2492a4fa3b5fc5b52cb975ed3"><strong id="en-us_topic_0057845637__b849050464">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.15%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="en-us_topic_0057845637__aeb29128c8bc6489593aaf12297635c52"><strong id="en-us_topic_0057845637__a105e6ed8c3de4c5a9dde97ae5a71071e_7">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.63%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="en-us_topic_0057845637__a367df15999ce47aa8fa2550bb2d3df9a"><strong id="en-us_topic_0057845637__a703d34a49a2f4162bc1a1a439f655f95_7">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37.269999999999996%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="en-us_topic_0057845637__a16a6b7e4145e4fbabf25e75163ec3f95"><strong id="en-us_topic_0057845637__b842352706114032_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845637__rb2ba995189ec478eb5d1181d3bb7be1c"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845637__aa1005da54f2c4746ae99676d14ab012d">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845637__a6d0540b177e34775b18c670cf5cd46bc">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.63%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845637__a65f6a6fc5a364d868072c58eeab90325">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.269999999999996%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845637__p1544652451214">Whether a user is enabled.</p>
|
|
<p id="en-us_topic_0057845637__ababe5d21d4764e209d225a4cea9b9fa2">The value can be <strong id="en-us_topic_0057845637__b2001396920">true</strong> or <strong id="en-us_topic_0057845637__b659788709">false</strong>. <strong id="en-us_topic_0057845637__b2052807057">true</strong> indicates the user is enabled and <strong id="en-us_topic_0057845637__b231565770">false</strong> indicates the user is not enabled. The default value is <strong id="en-us_topic_0057845637__b300429479">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__r41522dc2bd8d475b8d2a16af17d5213b"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845637__a2501c5b12ff94e338c0930e6c321af90">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845637__af10224f581d946cb91a49683adf34271">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.63%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845637__a0316e95fb756489a82f70ae562c523b4">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.269999999999996%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845637__af5ce8c5c520f468895f28d74f6eb4540">User ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__r1208cbb1496440d89eb758b2cd80d578"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845637__a4504807eb899465fb0ce3ac82d7013dc">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845637__en-us_topic_0026585113_p386591205643">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.63%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845637__a293aacc9b5354786a8b30a063a186b02">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.269999999999996%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845637__aa1138dcdd40340039e621e7abf0332e1">ID of the domain where a user is located.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__rbe8775b4e77a4b08be093de05e7bcbf3"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845637__acc4c499e1b2f4bdd98e5c7acd4e8861b">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845637__a4bf5dfe715d342e0a883343cbcf8181a">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.63%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845637__a8c424bac7d93444dbc647a1d5c5c21e4">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.269999999999996%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845637__afc48731c8a2e4c66a56ac245f7a1e34e">Username.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__row884150412952"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845637__p4507320312952">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845637__p2705079812952">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.63%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845637__p192144107220">JSON object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.269999999999996%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845637__p4445286212952">User resource link.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__row451303512957"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845637__p3001154112957">default_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845637__p1501577612957">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.63%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845637__p831835612957">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.269999999999996%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845637__p269819912957">Default project ID of a user.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__row62718260507"><td class="cellrowborder" valign="top" width="21.95%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845637__p192802695014">password_expires_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845637__p14282026125012">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.63%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845637__p202852615016">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.269999999999996%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845637__p228162616501">UTC when the password will expire. <strong id="en-us_topic_0057845637__b1483686226114627">null</strong> indicates that the password will not expire.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845637__en-us_topic_0026585112_ul10497152"><li id="en-us_topic_0057845637__lf3c28402a2ee4844bc99946ea67bf82d">Example response<pre class="screen" id="en-us_topic_0057845637__screen59248968161743">{
|
|
"user": {
|
|
"name": "jamesdoe",
|
|
"links": {
|
|
"self": "https://sample.domain.com/v3/users/614d1d2fb86940faab8f350bf1b9dbac"
|
|
},
|
|
"domain_id": "88b16b6440684467b8825d7d96e154d8",
|
|
"enabled": true,
|
|
"id": "614d1d2fb86940faab8f350bf1b9dbac",
|
|
"default_project_id": "acf2ffabba974fae8f30378ffde2cfa6",
|
|
"password_expires_at": null
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845637__sbfe93ca4c2b9427dbb2218a4e72da6a8"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845637__en-us_topic_0035544336_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845637__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_0057845637__en-us_topic_0035544336_p51565323"><strong id="en-us_topic_0057845637__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_0057845637__en-us_topic_0035544336_p16041657"><strong id="en-us_topic_0057845637__b842352706114032_7">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845637__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_0057845637__en-us_topic_0035544336_p22613965">201</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845637__en-us_topic_0035544336_p19791876">The user is successfully created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__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_0057845637__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_0057845637__en-us_topic_0035544336_p56751409">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__rb99fbab78bc54ae4953661763b573830"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845637__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_0057845637__a480215738ced4bf5a8feafa2681db93b">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__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_0057845637__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_0057845637__ae678037f26d640f5a985c943e2ffb92e">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__r1fd5c05b7b6b4c048f3f7b9ddbc755b0"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845637__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_0057845637__a9edf299d0513460caaac8a2a19b76e9a">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__rbb5133f150fd42eebde8dd6e390ecbd5"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845637__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_0057845637__a81837d461ef445259c5a6e9e1ce0e32a">The method specified in the request is not allowed for the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__row59784631174446"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845637__p10716980174446">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845637__p62769041174446">A resource conflict occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__r2cecff297b1a412f956a312d3cd7acc9"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845637__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_0057845637__ac31ead3ee2db40eea8ae45b2779a09e9">The request entity is too large.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__rd71e0e00759f4179a2dccaf345ba9f2f"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845637__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_0057845637__a88b4b14048564e12942b8151dc791b99">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845637__r5647e5fd26974514ac66cc3925f30601"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845637__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_0057845637__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>
|
|
|