forked from docs/doc-exports
Wei, Hongmin
80f18fd272
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>
202 lines
16 KiB
HTML
202 lines
16 KiB
HTML
<a name="en-us_topic_0057845618"></a><a name="en-us_topic_0057845618"></a>
|
|
|
|
<h1 class="topictitle1">Querying User Group Details</h1>
|
|
<div id="body1492670576089"><div class="section" id="en-us_topic_0057845618__section374725841447"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845618__p20801150560">This API is used to query detailed information about a user group.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845618__section37905744151541"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845618__ul5182186910218"><li id="en-us_topic_0057845618__en-us_topic_0032920307_li4839561">URI format<p id="en-us_topic_0057845618__en-us_topic_0032920307_p43556055"><a name="en-us_topic_0057845618__en-us_topic_0032920307_li4839561"></a><a name="en-us_topic_0032920307_li4839561"></a>GET /v3/groups/{group_id}</p>
|
|
</li><li id="en-us_topic_0057845618__li1205595994225">Query parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845618__table1045846915195" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845618__row5974534815195"><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_0057845618__p753502915195"><strong id="en-us_topic_0057845618__b84235270611173">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.24%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="en-us_topic_0057845618__p635761415195"><strong id="en-us_topic_0057845618__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.05%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="en-us_topic_0057845618__p4520476015195"><strong id="en-us_topic_0057845618__b842352706143526_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.35%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="en-us_topic_0057845618__p3770697115195"><strong id="en-us_topic_0057845618__b20601766145329">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845618__row3436579015195"><td class="cellrowborder" valign="top" width="19.36%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845618__p3216557715195">group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845618__p5527494915195">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845618__p4808588115195">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.35%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845618__p264231815195">ID of a user group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845618__section24249773152039"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845618__ul3118448103456"><li id="en-us_topic_0057845618__li46500394103456">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845618__en-us_topic_0032920307_table21736211" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845618__en-us_topic_0032920307_row48433347"><th align="left" class="cellrowborder" valign="top" width="19.49%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845618__en-us_topic_0032920307_p30787047"><strong id="en-us_topic_0057845618__a173ae121cc9e48328ca613e72f2a1504">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.86%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845618__en-us_topic_0032920307_p10722842"><strong id="en-us_topic_0057845618__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.34%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845618__en-us_topic_0032920307_p63243911"><strong id="en-us_topic_0057845618__b842352706143526_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.309999999999995%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845618__en-us_topic_0032920307_p22483156"><strong id="en-us_topic_0057845618__b1522845415265">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845618__en-us_topic_0032920307_row9196329"><td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845618__en-us_topic_0032920307_p6705199">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.86%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845618__en-us_topic_0032920307_p6250253">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.34%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845618__en-us_topic_0032920307_p36508524">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.309999999999995%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845618__en-us_topic_0032920307_p4400500">Fill <strong id="en-us_topic_0057845618__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845618__en-us_topic_0032920307_row39604502"><td class="cellrowborder" valign="top" width="19.49%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845618__en-us_topic_0032920307_p53848109">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.86%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845618__en-us_topic_0032920307_p66729601">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.34%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845618__en-us_topic_0032920307_p36388601">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.309999999999995%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845618__p2531632811434">Authenticated token with the <strong id="en-us_topic_0057845618__b750798910387">Security Administrator</strong> permission.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845618__ul16894141815814"><li id="en-us_topic_0057845618__li18941118285">Example request<pre class="screen" id="en-us_topic_0057845618__screen0894118983"><em id="en-us_topic_0057845618__i1189418187816">curl -i -k -H "X-Auth-Token:$token" -H 'Content-Type:application/json;charset=utf8' -X GET https://sample.domain.com/v3/groups/ab9f261180d746ef8624beb5ae39b5aa</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845618__section58835528153619"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845618__ul5464199010524"><li id="en-us_topic_0057845618__li6140614310524">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845618__table1056195410010" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845618__row2747156110010"><th align="left" class="cellrowborder" valign="top" width="18.81188118811881%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845618__p447620910517"><strong id="en-us_topic_0057845618__b1702849807">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.761976197619763%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845618__p17754564499"><strong id="en-us_topic_0057845618__a105e6ed8c3de4c5a9dde97ae5a71071e_5">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.01190119011901%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845618__p755696810517"><strong id="en-us_topic_0057845618__b842352706143526_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.41424142414241%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845618__p6407638510517"><strong id="en-us_topic_0057845618__b230267746154854">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845618__row570214510010"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845618__p5922062510010">group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.761976197619763%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845618__p87595644915">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.01190119011901%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845618__p5331155510010">JSON object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.41424142414241%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845618__p2326866010010">Response body of a user group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845618__row809135110010"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845618__p53468292105715">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.761976197619763%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845618__p1875135616490">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.01190119011901%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845618__p852996010010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.41424142414241%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845618__p1983818310010">Description for a user group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845618__row23913924105725"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845618__p13898724105725">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.761976197619763%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845618__p157565634918">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.01190119011901%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845618__p52054821105725">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.41424142414241%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845618__p55690967105725">ID of the domain to which a user group belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845618__row43504723105810"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845618__p55998188105810">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.761976197619763%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845618__p375175610498">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.01190119011901%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845618__p39559385105810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.41424142414241%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845618__p50193635105810">ID of a user group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845618__row42687591105820"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845618__p48644001105820">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.761976197619763%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845618__p1876556104917">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.01190119011901%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845618__p47850047105820">JSON object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.41424142414241%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845618__p50648609105820">Links to a user group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845618__row1704891105830"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845618__p15344026105830">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.761976197619763%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845618__p57695694919">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.01190119011901%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845618__p34906626105830">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.41424142414241%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845618__p8864442105830">Name of a user group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845618__row1815813393114"><td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845618__p41591433113114">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.761976197619763%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845618__p19761056154914">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.01190119011901%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845618__p515903373115">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.41424142414241%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845618__p315918330319">Time when a user group is created.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845618__li37517461811">Example response<pre class="screen" id="en-us_topic_0057845618__screen426225154928">{
|
|
"group":{
|
|
"domain_id":"d54061ebcb5145dd814f8eb3fe9b7ac0",
|
|
"description":"Contract developers",
|
|
"id":"ab9f261180d746ef8624beb5ae39b5aa",
|
|
"links":{
|
|
"self":"https://sample.domain.com/v3/groups/ab9f261180d746ef8624beb5ae39b5aa"
|
|
},
|
|
"name":"abcdef",
|
|
"create_time": 1494943784468
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845618__section5556784894735"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845618__en-us_topic_0032920307_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845618__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_0057845618__en-us_topic_0032920307_p51565323"><strong id="en-us_topic_0057845618__b2587340315265">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_0057845618__en-us_topic_0032920307_p16041657"><strong id="en-us_topic_0057845618__b412025515265">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845618__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_0057845618__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_0057845618__en-us_topic_0032920307_p19791876">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845618__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_0057845618__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_0057845618__en-us_topic_0032920307_p56751409">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845618__row460808479497"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845618__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_0057845618__p385055099497">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845618__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_0057845618__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_0057845618__en-us_topic_0032920307_p32846614">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845618__row1306642216138"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845618__p5048894216138">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845618__p6307248716138">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_0057845641.html">User Group Management</a></div>
|
|
</div>
|
|
</div>
|
|
|