forked from docs/doc-exports
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>
334 lines
31 KiB
HTML
334 lines
31 KiB
HTML
<a name="en-us_topic_0057845561"></a><a name="en-us_topic_0057845561"></a>
|
|
|
|
<h1 class="topictitle1">Querying Users in a User Group</h1>
|
|
<div id="body1492741255664"><div class="section" id="en-us_topic_0057845561__section495175389414"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845561__p1222771513417">This API is used to query users in a user group.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845561__section3019338085013"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845561__en-us_topic_0032920307_ul52733512"><li id="en-us_topic_0057845561__en-us_topic_0032920307_li4839561">URI format<p id="en-us_topic_0057845561__en-us_topic_0032920307_p43556055"><a name="en-us_topic_0057845561__en-us_topic_0032920307_li4839561"></a><a name="en-us_topic_0032920307_li4839561"></a>GET /v3/groups/{group_id}/users</p>
|
|
</li><li id="en-us_topic_0057845561__li1205595994225">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845561__en-us_topic_0032920307_table36168141" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845561__en-us_topic_0032920307_row15662289"><th align="left" class="cellrowborder" valign="top" width="19.36%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="en-us_topic_0057845561__en-us_topic_0032920307_p60685926"><strong id="en-us_topic_0057845561__b842352706161530">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.77%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="en-us_topic_0057845561__en-us_topic_0032920307_p16612996"><strong id="en-us_topic_0057845561__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.25%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="en-us_topic_0057845561__en-us_topic_0032920307_p3475410"><strong id="en-us_topic_0057845561__a703d34a49a2f4162bc1a1a439f655f95_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.620000000000005%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="en-us_topic_0057845561__en-us_topic_0032920307_p13072760"><strong id="en-us_topic_0057845561__b842352706114032_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845561__en-us_topic_0032920307_row52260639"><td class="cellrowborder" valign="top" width="19.36%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_p5253358">group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.77%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_p22868878">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.25%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_p40439847">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.620000000000005%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_p54402144">ID of a user group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845561__li26644734164014">Query parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845561__table38476019164014" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845561__row56436571164014"><th align="left" class="cellrowborder" valign="top" width="19.439999999999998%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="en-us_topic_0057845561__p7959515164014"><strong id="en-us_topic_0057845561__b1285459850">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.43%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="en-us_topic_0057845561__p40740988164014"><strong id="en-us_topic_0057845561__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.64%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="en-us_topic_0057845561__p11685733164014"><strong id="en-us_topic_0057845561__a703d34a49a2f4162bc1a1a439f655f95_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.49%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="en-us_topic_0057845561__p7020351164014"><strong id="en-us_topic_0057845561__b842352706114032_3">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845561__row31777586164014"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="en-us_topic_0057845561__p23847653164014">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.43%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="en-us_topic_0057845561__p52611712164014">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.64%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="en-us_topic_0057845561__p33690284164014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="en-us_topic_0057845561__p44558480164014">ID of the domain to which a user group belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__row65482007164014"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="en-us_topic_0057845561__p2442371164014">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.43%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="en-us_topic_0057845561__p63614396164014">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.64%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="en-us_topic_0057845561__p52492457164014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="en-us_topic_0057845561__p24030643164014">Name of a user. The maximum length is 64 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__row20100318164057"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="en-us_topic_0057845561__p46685139164057">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.43%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="en-us_topic_0057845561__p66073055164128">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.64%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="en-us_topic_0057845561__p50317259164128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="en-us_topic_0057845561__p48949399164057">Whether a user is enabled. The value can be <strong id="en-us_topic_0057845561__b842352706182927">true</strong> or <strong id="en-us_topic_0057845561__b842352706182931">false</strong>. <strong id="en-us_topic_0057845561__b1586036687182937">true</strong> indicates the user is enabled and <strong id="en-us_topic_0057845561__b77525951182937">false</strong> indicates the user is not enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__row172741544195812"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="en-us_topic_0057845561__p122311493521">password_expires_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.43%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="en-us_topic_0057845561__p1823334995215">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.64%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="en-us_topic_0057845561__p623364945219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="en-us_topic_0057845561__p1123314965211">Password expiration time. The format is <strong id="en-us_topic_0057845561__b842352706153618">password_expires_at=</strong><em id="en-us_topic_0057845561__i842352697153316">operator</em><strong id="en-us_topic_0057845561__b842352706153622">:</strong><em id="en-us_topic_0057845561__i842352697153329">timestamp</em>.</p>
|
|
<p id="en-us_topic_0057845561__p1838112538569">Example:</p>
|
|
<pre class="screen" id="en-us_topic_0057845561__screen85910169576">password_expires_at=lt:2016-12-08T22:02:00Z</pre>
|
|
<ul id="en-us_topic_0057845561__ul9511557111910"><li id="en-us_topic_0057845561__li202801231152010">The value of <strong id="en-us_topic_0057845561__b842352706153734">operator</strong> can be <strong id="en-us_topic_0057845561__b842352706153825">lt</strong>, <strong id="en-us_topic_0057845561__b842352706153821">lte</strong>, <strong id="en-us_topic_0057845561__b842352706153814">gt</strong>, <strong id="en-us_topic_0057845561__b84235270615388">gte</strong>, <strong id="en-us_topic_0057845561__b84235270615384">eq</strong>, or <strong id="en-us_topic_0057845561__b84235270615380">neq</strong>.<ul id="en-us_topic_0057845561__ul1162653632014"><li id="en-us_topic_0057845561__li135114576199"><strong id="en-us_topic_0057845561__b84235270615395">lt</strong>: The expiration time is earlier than <em id="en-us_topic_0057845561__i842352697154057">timestamp</em>.</li><li id="en-us_topic_0057845561__li105111357141919"><strong id="en-us_topic_0057845561__b842352706154029">lte</strong>: The expiration time is earlier than or equal to <em id="en-us_topic_0057845561__i84235269715416">timestamp</em>.</li><li id="en-us_topic_0057845561__li1051105711913"><strong id="en-us_topic_0057845561__b2140359020">gt</strong>: The expiration time is later than <em id="en-us_topic_0057845561__i84235269715427">timestamp</em>.</li><li id="en-us_topic_0057845561__li12511155771910"><strong id="en-us_topic_0057845561__b1273962280">gte</strong>: The expiration time is equal to or later than <em id="en-us_topic_0057845561__i2092264561">timestamp</em>.</li><li id="en-us_topic_0057845561__li551117578195"><strong id="en-us_topic_0057845561__b1429401193">eq</strong>: The expiration time is equal to <em id="en-us_topic_0057845561__i383741121">timestamp</em>.</li><li id="en-us_topic_0057845561__li12511457131911"><strong id="en-us_topic_0057845561__b1093874791">neq</strong>: The expiration time is not equal to <em id="en-us_topic_0057845561__i793940306">timestamp</em>.</li></ul>
|
|
</li><li id="en-us_topic_0057845561__li12801831182017">The <strong id="en-us_topic_0057845561__b842352706154327">timestamp</strong> format is <strong id="en-us_topic_0057845561__b842352706154332">YYYY-MM-DDTHH:mm:ssZ</strong>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845561__section1437107585444"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845561__ul3118448103456"><li id="en-us_topic_0057845561__li46500394103456">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845561__en-us_topic_0032920307_table21736211" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845561__en-us_topic_0032920307_row48433347"><th align="left" class="cellrowborder" valign="top" width="19.62%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845561__en-us_topic_0032920307_p30787047"><strong id="en-us_topic_0057845561__a6f95694edbbb43d8a152536754b86c82_1">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845561__en-us_topic_0032920307_p10722842"><strong id="en-us_topic_0057845561__a105e6ed8c3de4c5a9dde97ae5a71071e_5">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.5%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845561__en-us_topic_0032920307_p63243911"><strong id="en-us_topic_0057845561__a703d34a49a2f4162bc1a1a439f655f95_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.49%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845561__en-us_topic_0032920307_p22483156"><strong id="en-us_topic_0057845561__b842352706114032_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845561__en-us_topic_0032920307_row9196329"><td class="cellrowborder" valign="top" width="19.62%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_p6705199">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_p6250253">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.5%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_p36508524">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_p4400500">Fill <strong id="en-us_topic_0057845561__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__en-us_topic_0032920307_row39604502"><td class="cellrowborder" valign="top" width="19.62%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_p53848109">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_p66729601">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.5%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_p36388601">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.49%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845561__p6097796794746">Authenticated token with the <strong id="en-us_topic_0057845561__b750798910387">Security Administrator</strong> permission.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845561__li105651343943">Example request<pre class="screen" id="en-us_topic_0057845561__screen1556515439411"><em id="en-us_topic_0057845561__i145651043746">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/groups/00007111583e457389b0d4252643181b/users</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845561__section422798898594"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845561__ul5464199010524"><li id="en-us_topic_0057845561__li6140614310524">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845561__table1056195410010" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845561__row2747156110010"><th align="left" class="cellrowborder" valign="top" width="19.541954195419542%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845561__p447620910517"><strong id="en-us_topic_0057845561__a6f95694edbbb43d8a152536754b86c82_3">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.58195819581958%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845561__p182061578189"><strong id="en-us_topic_0057845561__a105e6ed8c3de4c5a9dde97ae5a71071e_7">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.19181918191819%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845561__p755696810517"><strong id="en-us_topic_0057845561__a703d34a49a2f4162bc1a1a439f655f95_7">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.684268426842685%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845561__p6407638510517"><strong id="en-us_topic_0057845561__b842352706114032_7">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845561__row570214510010"><td class="cellrowborder" valign="top" width="19.541954195419542%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845561__p5922062510010">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.58195819581958%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845561__p182061673183">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.19181918191819%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845561__p12656935926">JSON object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.684268426842685%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845561__p2326866010010">User resource link of a user group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__row809135110010"><td class="cellrowborder" valign="top" width="19.541954195419542%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845561__p5141972010010">users</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.58195819581958%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845561__p32068771816">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.19181918191819%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845561__p16554338420">JSONArray</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.684268426842685%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845561__p1983818310010">List of users in a user group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845561__l6c7badc7da784e62ae4b0b7c757a339a">Description for the user format
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845561__en-us_topic_0057845638_table683623312113" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845561__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_0057845561__en-us_topic_0057845638_p484813315212"><strong id="en-us_topic_0057845561__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_0057845561__en-us_topic_0057845638_p88525332215"><strong id="en-us_topic_0057845561__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_0057845561__en-us_topic_0057845638_p14856183320218"><strong id="en-us_topic_0057845561__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_0057845561__en-us_topic_0057845638_p286173320218">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__en-us_topic_0057845638_p6874133172114">Description for a user.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__en-us_topic_0057845638_p3888143315211">ID of the tenant that the user belongs to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__en-us_topic_0057845638_p12901113312215">Indicates whether the user is enabled. The value can be <strong id="en-us_topic_0057845561__en-us_topic_0057845638_b0372455203917">true</strong> or <strong id="en-us_topic_0057845561__en-us_topic_0057845638_b4751556173915">false</strong>. The default value is <strong id="en-us_topic_0057845561__en-us_topic_0057845638_b74111258193916">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__en-us_topic_0057845638_p091212333214">User ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__en-us_topic_0057845638_p192211334219">User resource link.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__en-us_topic_0057845638_p29351333192112">Username.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__en-us_topic_0057845638_p294619332218">UTC time when the password will expire. <strong id="en-us_topic_0057845561__en-us_topic_0057845638_b1483686226114627">null</strong> indicates that the password will not expire.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__en-us_topic_0057845638_p09601033172120">Password status. <strong id="en-us_topic_0057845561__en-us_topic_0057845638_b355111133319">true</strong> means that the password needs to be changed, and <strong id="en-us_topic_0057845561__en-us_topic_0057845638_b11550112333">false</strong> means that the password is normal.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__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_0057845561__en-us_topic_0057845638_p2570112853116">User email address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845561__li16460414650">Example response<pre class="screen" id="en-us_topic_0057845561__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&enabled=false",
|
|
"previous": null,
|
|
"next": null
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845561__section5556784894735"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845561__en-us_topic_0032920307_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845561__en-us_topic_0032920307_row10578662"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845561__en-us_topic_0032920307_p51565323"><strong id="en-us_topic_0057845561__b54569330171957">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_0057845561__en-us_topic_0032920307_p16041657"><strong id="en-us_topic_0057845561__b842352706114032_11">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845561__en-us_topic_0032920307_row24305815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_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_0057845561__en-us_topic_0032920307_p19791876">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__en-us_topic_0032920307_row43909159"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_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_0057845561__en-us_topic_0032920307_p56751409">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__row460808479497"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845561__p120744399497">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845561__p385055099497">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__en-us_topic_0032920307_row41000636"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845561__en-us_topic_0032920307_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_0057845561__en-us_topic_0032920307_p32846614">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845561__row2569718985351"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845561__p2994811485351">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845561__p987817085351">The requested resource cannot be found.</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>
|
|
|