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_0057845638.html
Wei, Hongmin c7cf8ac24f IAM API 0711 Version 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2024-07-11 11:57:45 +00:00

332 lines
30 KiB
HTML
Raw Blame History

<a name="en-us_topic_0057845638"></a><a name="en-us_topic_0057845638"></a>
<h1 class="topictitle1">Querying a User List</h1>
<div id="body1492687691586"><div class="section" id="en-us_topic_0057845638__s5888597838b0425a92e3419fb766c7f5"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845638__p1887819285319">This API is used to query a user list.</p>
</div>
<div class="section" id="en-us_topic_0057845638__s46d3616bd4c54e55ba97a528518a5890"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845638__en-us_topic_0026585112_ul20917673"><li id="en-us_topic_0057845638__l0762c927197248c39057087e143d6575">URI format<p id="en-us_topic_0057845638__p5594901411559"><a name="en-us_topic_0057845638__l0762c927197248c39057087e143d6575"></a><a name="l0762c927197248c39057087e143d6575"></a>GET /v3/users</p>
</li><li id="en-us_topic_0057845638__li2733311911542">URI parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845638__table2671410511552" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845638__row2181345411552"><th align="left" class="cellrowborder" valign="top" width="22.14%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="en-us_topic_0057845638__p4197580011552"><strong id="en-us_topic_0057845638__a6f95694edbbb43d8a152536754b86c82_1">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.09%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="en-us_topic_0057845638__p5555552611552"><strong id="en-us_topic_0057845638__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.11%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="en-us_topic_0057845638__p3157154611552"><strong id="en-us_topic_0057845638__a703d34a49a2f4162bc1a1a439f655f95_1">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.66%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="en-us_topic_0057845638__p4296341111552"><strong id="en-us_topic_0057845638__b842352706114032">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845638__row2571374511552"><td class="cellrowborder" valign="top" width="22.14%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p6330725211552">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.09%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p2212117911552">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.11%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p4769668011552">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.66%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p928844211552">ID of the domain that a user belongs to.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row1416632711552"><td class="cellrowborder" valign="top" width="22.14%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p6660449211552">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="20.09%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p4626117411552">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.11%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p5328411711552">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.66%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p2702541811552">Whether a user is enabled. <strong id="en-us_topic_0057845638__b35734309114924">true</strong> indicates that the user is enabled. <strong id="en-us_topic_0057845638__b51021073114926">false</strong> indicates that the user is disabled. The default value is <strong id="en-us_topic_0057845638__b10453693114924">true</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row4157523011552"><td class="cellrowborder" valign="top" width="22.14%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p4466247811552">name</p>
</td>
<td class="cellrowborder" valign="top" width="20.09%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p3321824211552">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.11%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p4240978811552">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.66%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p1727292311552">Username.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row923064925220"><td class="cellrowborder" valign="top" width="22.14%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p122311493521">password_expires_at</p>
</td>
<td class="cellrowborder" valign="top" width="20.09%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p1823334995215">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.11%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p623364945219">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.66%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p1123314965211">Password expiration time. The format is <strong id="en-us_topic_0057845638__b842352706153618">password_expires_at=</strong><em id="en-us_topic_0057845638__i842352697153316">operator</em><strong id="en-us_topic_0057845638__b842352706153622">:</strong><em id="en-us_topic_0057845638__i842352697153329">timestamp</em>.</p>
<p id="en-us_topic_0057845638__p1838112538569">Example:</p>
<pre class="screen" id="en-us_topic_0057845638__screen85910169576">password_expires_at=lt:2016-12-08T22:02:00Z</pre>
<ul id="en-us_topic_0057845638__ul9511557111910"><li id="en-us_topic_0057845638__li202801231152010">The value of <strong id="en-us_topic_0057845638__b842352706153734">operator</strong> can be <strong id="en-us_topic_0057845638__b842352706153825">lt</strong>, <strong id="en-us_topic_0057845638__b842352706153821">lte</strong>, <strong id="en-us_topic_0057845638__b842352706153814">gt</strong>, <strong id="en-us_topic_0057845638__b84235270615388">gte</strong>, <strong id="en-us_topic_0057845638__b84235270615384">eq</strong>, or <strong id="en-us_topic_0057845638__b84235270615380">neq</strong>.<ul id="en-us_topic_0057845638__ul1162653632014"><li id="en-us_topic_0057845638__li135114576199"><strong id="en-us_topic_0057845638__b84235270615395">lt</strong>: The expiration time is earlier than <em id="en-us_topic_0057845638__i842352697154057">timestamp</em>.</li><li id="en-us_topic_0057845638__li105111357141919"><strong id="en-us_topic_0057845638__b842352706154029">lte</strong>: The expiration time is earlier than or equal to <em id="en-us_topic_0057845638__i84235269715416">timestamp</em>.</li><li id="en-us_topic_0057845638__li1051105711913"><strong id="en-us_topic_0057845638__b99324987">gt</strong>: The expiration time is later than <em id="en-us_topic_0057845638__i84235269715427">timestamp</em>.</li><li id="en-us_topic_0057845638__li12511155771910"><strong id="en-us_topic_0057845638__b1100162723">gte</strong>: The expiration time is equal to or later than <em id="en-us_topic_0057845638__i505285739">timestamp</em>.</li><li id="en-us_topic_0057845638__li551117578195"><strong id="en-us_topic_0057845638__b1932450324">eq</strong>: The expiration time is equal to <em id="en-us_topic_0057845638__i809194230">timestamp</em>.</li><li id="en-us_topic_0057845638__li12511457131911"><strong id="en-us_topic_0057845638__b110130912">neq</strong>: The expiration time is not equal to <em id="en-us_topic_0057845638__i900839580">timestamp</em>.</li></ul>
</li><li id="en-us_topic_0057845638__li12801831182017">The <strong id="en-us_topic_0057845638__b842352706154327">timestamp</strong> format is <strong id="en-us_topic_0057845638__b842352706154332">YYYY-MM-DDTHH:mm:ssZ</strong>.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845638__se7fe5cac0d544e119c49322cc1707eb6"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845638__en-us_topic_0026585112_ul3226198"><li id="en-us_topic_0057845638__l7c4919f55ea849a9bb59e1454113085c">Parameters in the request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845638__t68c7bd10e66a4380a1e6cdc78ca95669" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845638__r584496594a404ce18918a40e6e57c2ec"><th align="left" class="cellrowborder" valign="top" width="21.81218121812181%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845638__ac3a989cc5d3a405889eabb47dee84b04"><strong id="en-us_topic_0057845638__a6f95694edbbb43d8a152536754b86c82_3">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.352035203520348%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845638__a69a20ac00b86496aa8418517c542b0da"><strong id="en-us_topic_0057845638__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.092009200920092%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845638__a92c23d4441054df0972e025aeb3a8d7f"><strong id="en-us_topic_0057845638__a703d34a49a2f4162bc1a1a439f655f95_3">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.743774377437745%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845638__abe6882c44cf4402d8ed7706b9278f33b"><strong id="en-us_topic_0057845638__b50354700121445">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845638__r5d63069d6a8a426e8b25b94d1b4d302a"><td class="cellrowborder" valign="top" width="21.81218121812181%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845638__ad4fb6253385c46ab8720a0e13f573694">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20.352035203520348%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845638__a6b33800bcb2a446695b1d33a2d751554">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.092009200920092%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845638__ab34a5e95b76b4b79a72da0734025f211">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.743774377437745%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845638__a716277ae541d4553bb10490f9c02593d">Fill <strong id="en-us_topic_0057845638__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row29501427115257"><td class="cellrowborder" valign="top" width="21.81218121812181%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845638__p6637478211538">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20.352035203520348%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845638__p764826811538">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.092009200920092%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845638__p1553001111538">String</p>
</td>
<td class="cellrowborder" valign="top" width="37.743774377437745%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845638__p3577810173953">Authenticated token with the <strong id="en-us_topic_0057845638__b32749661102843">Security Administrator</strong> permission.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845638__en-us_topic_0026585112_li17042198">Example request<pre class="screen" id="en-us_topic_0057845638__s6b85ed1428f745fabd2d60e4481ee1db"><em id="en-us_topic_0057845638__i79494215553">curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://sample.domain.com/v3/users</em></pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845638__s3a08e13bb5b34dc2ba4dcd84a0d51cf5"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845638__u038cb568d63e46ac95f0986f79d7bc03"><li id="en-us_topic_0057845638__l2e0c2ec3fbf640ca9f98448f23594a13">Parameters in the response body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845638__t1266dd240c3649048c9f42af34a0686b" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845638__rd8ac2cd80e4b47d684b61df4f3c570cf"><th align="left" class="cellrowborder" valign="top" width="21.68%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845638__ad167d1bf89ca443eac693ea562da12a3"><strong id="en-us_topic_0057845638__a6f95694edbbb43d8a152536754b86c82_5">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.49%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845638__aad08ea1f8c8e4a42a1a81112a74cb237"><strong id="en-us_topic_0057845638__a105e6ed8c3de4c5a9dde97ae5a71071e_5">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.349999999999998%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845638__a9b5fafff0348408893dcc06fbe0b1186"><strong id="en-us_topic_0057845638__a703d34a49a2f4162bc1a1a439f655f95_5">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.480000000000004%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845638__ad002a0bf107a468884a5777e55f837f6"><strong id="en-us_topic_0057845638__b30945568121445">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845638__ref3b81e8e64e418c961ca1bce6f25280"><td class="cellrowborder" valign="top" width="21.68%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845638__abb2b4d81b907497da50ad4f12760f7dc">users</p>
</td>
<td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845638__a7e49a4eaca054e36ba774b0cdc492081">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.349999999999998%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845638__p9747112319316">JSONArray</p>
</td>
<td class="cellrowborder" valign="top" width="37.480000000000004%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845638__a8ded0409c6d948dc82f7f779a4cfa5b8">User list.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row43686692165815"><td class="cellrowborder" valign="top" width="21.68%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845638__p48961187165815">links</p>
</td>
<td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845638__p6433206165815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.349999999999998%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845638__p819418211314">JSON object</p>
</td>
<td class="cellrowborder" valign="top" width="37.480000000000004%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845638__p63901882165815">Links of a user resource.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0057845638__l86920d09d4224a93a4379c10a51077f0">Description for the user format
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845638__table683623312113" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845638__row19845533162112"><th align="left" class="cellrowborder" valign="top" width="19.81%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="en-us_topic_0057845638__p484813315212"><strong id="en-us_topic_0057845638__a6f95694edbbb43d8a152536754b86c82_7">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.45%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="en-us_topic_0057845638__p88525332215"><strong id="en-us_topic_0057845638__b430574702">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.91%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="en-us_topic_0057845638__p14856183320218"><strong id="en-us_topic_0057845638__b2122474095">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.83%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="en-us_topic_0057845638__p286173320218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845638__row3863153311217"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p88666332215">description</p>
</td>
<td class="cellrowborder" valign="top" width="19.45%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p386916336212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p7871123352112">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.83%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p6874133172114">Description for a user.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row128753339212"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p18877113392115">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.45%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p1487933362114">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p1388513334213">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.83%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p3888143315211">ID of the tenant that the user belongs to.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row089017338215"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p1389315339212">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="19.45%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p3896123318213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p13899103317210">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="42.83%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p12901113312215">Indicates whether the user is enabled. The value can be <strong id="en-us_topic_0057845638__b0372455203917">true</strong> or <strong id="en-us_topic_0057845638__b4751556173915">false</strong>. The default value is <strong id="en-us_topic_0057845638__b74111258193916">true</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row29030337213"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p890513302110">id</p>
</td>
<td class="cellrowborder" valign="top" width="19.45%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p189081733112118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p691093332117">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.83%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p091212333214">User ID.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row20913123342114"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p1391415332215">links</p>
</td>
<td class="cellrowborder" valign="top" width="19.45%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p391693315216">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p189191933182113">JSON object</p>
</td>
<td class="cellrowborder" valign="top" width="42.83%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p192211334219">User resource link.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row179247335217"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p119261133192110">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.45%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p189291933142116">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p493213315214">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.83%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p29351333192112">Username.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row193643316211"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p1393815334212">password_expires_at</p>
</td>
<td class="cellrowborder" valign="top" width="19.45%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p1194143312119">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p18943633142112">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.83%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p294619332218">UTC time when the password will expire. <strong id="en-us_topic_0057845638__b1483686226114627">null</strong> indicates that the password will not expire.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row294912331214"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p17951143302120">pwd_status</p>
</td>
<td class="cellrowborder" valign="top" width="19.45%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p11955533102116">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p29573333214">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="42.83%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p09601033172120">Password status. <strong id="en-us_topic_0057845638__b355111133319">true</strong> means that the password needs to be changed, and <strong id="en-us_topic_0057845638__b11550112333">false</strong> means that the password is normal.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row1161234152117"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p519173417211">default_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.45%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p18213344218">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p423193420211">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.83%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p1925143462116">ID of the project that is displayed by default when the user logs in to the console.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row9263348215"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p1330334112110">last_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.45%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p1232193418212">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p17361734142110">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.83%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p203843472112">ID of the project that the user lastly accessed before exiting the system.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__row139771016194810"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845638__p1956972863112">email</p>
</td>
<td class="cellrowborder" valign="top" width="19.45%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845638__p769116215485">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.91%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845638__p1570192813118">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.83%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845638__p2570112853116">User email address.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0057845638__en-us_topic_0026585112_ul10497152"><li id="en-us_topic_0057845638__lf3c28402a2ee4844bc99946ea67bf82d">Example response<pre class="screen" id="en-us_topic_0057845638__sf943dd4d83494c55a12db23ebfa9eb99">{
"users": [{
"name": "username",
"links": {
"self": "https://sample.domain.com/v3/users/6d8b04e3bf99445b8f76300xxx"
},
"description": "1234",
"domain_id": "88b16b6440684467b8825d7xxx",
"enabled": false,
"id": "6d8b04e3bf99445b8f763009xxx",
"email" : ""
"default_project_id": "263fd9",
"password_expires_at": "2016-12-07T00:00:00.000000Z",
"pwd_status": true,
"last_project_id": ""
}],
"links": {
"self": "https://sample.domain.com/v3/users?domain_id=88b16b6440684467b882xxx154d8&amp;enabled=false",
"previous": null,
"next": null
}
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0057845638__sbfe93ca4c2b9427dbb2218a4e72da6a8"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845638__en-us_topic_0035544336_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845638__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_0057845638__en-us_topic_0035544336_p51565323"><strong id="en-us_topic_0057845638__b842352706183757">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_0057845638__en-us_topic_0035544336_p16041657"><strong id="en-us_topic_0057845638__b38983553121445">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845638__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_0057845638__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_0057845638__en-us_topic_0035544336_p19791876">The request is successful.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__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_0057845638__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_0057845638__en-us_topic_0035544336_p56751409">The server failed to process the request.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__rb99fbab78bc54ae4953661763b573830"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845638__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_0057845638__a480215738ced4bf5a8feafa2681db93b">Authentication failed.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__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_0057845638__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_0057845638__ae678037f26d640f5a985c943e2ffb92e">Access denied.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__r1fd5c05b7b6b4c048f3f7b9ddbc755b0"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845638__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_0057845638__a9edf299d0513460caaac8a2a19b76e9a">The requested resource cannot be found.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__rbb5133f150fd42eebde8dd6e390ecbd5"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845638__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_0057845638__a81837d461ef445259c5a6e9e1ce0e32a">The method specified in the request is not allowed for the requested resource.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__r2cecff297b1a412f956a312d3cd7acc9"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845638__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_0057845638__ac31ead3ee2db40eea8ae45b2779a09e9">The request entity is too large.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__rd71e0e00759f4179a2dccaf345ba9f2f"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845638__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_0057845638__a88b4b14048564e12942b8151dc791b99">Internal server error.</p>
</td>
</tr>
<tr id="en-us_topic_0057845638__r5647e5fd26974514ac66cc3925f30601"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845638__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_0057845638__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