doc-exports/docs/iam/api-ref/iam_02_0519.html
Wei, Hongmin 80f18fd272 IAM API 2.6 Version
Reviewed-by: Kabai, Zoltán Gábor <zoltan-gabor.kabai@t-systems.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2023-08-03 03:34:59 +00:00

126 lines
9.5 KiB
HTML

<a name="iam_02_0519"></a><a name="iam_02_0519"></a>
<h1 class="topictitle1">Granting Permissions to a User Group for All Projects</h1>
<div id="body1569029477059"><div class="section" id="iam_02_0519__section495175389414"><h4 class="sectiontitle">Function</h4><p id="iam_02_0519__p14729421679">This API is used to grant permissions to a user group for all projects.</p>
</div>
<div class="section" id="iam_02_0519__section3019338085013"><h4 class="sectiontitle">URI</h4><ul id="iam_02_0519__en-us_topic_0032920307_ul52733512"><li id="iam_02_0519__en-us_topic_0032920307_li4839561">URI format<p id="iam_02_0519__p4784144133411"><a name="iam_02_0519__en-us_topic_0032920307_li4839561"></a><a name="en-us_topic_0032920307_li4839561"></a>PUT /v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects</p>
</li><li id="iam_02_0519__li40941434103446">URI parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0519__en-us_topic_0032920307_table36168141" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0519__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="iam_02_0519__en-us_topic_0032920307_p60685926">Parameter</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="iam_02_0519__en-us_topic_0032920307_p16612996">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.18%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="iam_02_0519__en-us_topic_0032920307_p3475410">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.22%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="iam_02_0519__en-us_topic_0032920307_p13072760">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0519__row122381042113416"><td class="cellrowborder" valign="top" width="19.36%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="iam_02_0519__p11239142163417">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="iam_02_0519__p1923964214341">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.18%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="iam_02_0519__p7592125815347">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.22%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="iam_02_0519__p55690967105725">ID of the domain to which a user group belongs.</p>
</td>
</tr>
<tr id="iam_02_0519__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="iam_02_0519__en-us_topic_0032920307_p5253358">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="iam_02_0519__en-us_topic_0032920307_p22868878">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.18%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="iam_02_0519__en-us_topic_0032920307_p40439847">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.22%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="iam_02_0519__en-us_topic_0032920307_p54402144">ID of a user group.</p>
</td>
</tr>
<tr id="iam_02_0519__row980208103522"><td class="cellrowborder" valign="top" width="19.36%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="iam_02_0519__p14334102033414">role_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.24%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="iam_02_0519__p43483414103522">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.18%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="iam_02_0519__p32495677103522">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.22%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="iam_02_0519__p14904143103522">User role ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="iam_02_0519__section1437107585444"><h4 class="sectiontitle">Request Parameters</h4><ul id="iam_02_0519__ul3118448103456"><li id="iam_02_0519__li46500394103456">Parameters in the request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0519__en-us_topic_0032920307_table21736211" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0519__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="iam_02_0519__en-us_topic_0032920307_p30787047">Parameter</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="iam_02_0519__en-us_topic_0032920307_p10722842">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.57%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="iam_02_0519__en-us_topic_0032920307_p63243911">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.080000000000005%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="iam_02_0519__en-us_topic_0032920307_p22483156">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0519__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="iam_02_0519__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="iam_02_0519__en-us_topic_0032920307_p6250253">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="iam_02_0519__en-us_topic_0032920307_p36508524">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.080000000000005%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="iam_02_0519__en-us_topic_0032920307_p4400500">Fill <span class="parmvalue" id="iam_02_0519__parmvalue9815056141113"><b>application/json;charset=utf8</b></span> in this field.</p>
</td>
</tr>
<tr id="iam_02_0519__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="iam_02_0519__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="iam_02_0519__en-us_topic_0032920307_p66729601">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.57%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="iam_02_0519__en-us_topic_0032920307_p36388601">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.080000000000005%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="iam_02_0519__p3946364911720">User token (of a specified domain ID) with <strong id="iam_02_0519__b1372655114136">secu_admin</strong> permissions or a token with <strong id="iam_02_0519__b1528518261159">op_service</strong> or <strong id="iam_02_0519__b2049217269156">op_auth</strong> permissions.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="iam_02_0519__ul2355895152636"><li id="iam_02_0519__li9667726152636">Example request<pre class="screen" id="iam_02_0519__screen1468833112385"><em id="iam_02_0519__i189271154143812">curl -i -k -H "X-Auth-Token:$token" -X PUT https://sample.domain.com/v3/OS-INHERIT/domains/{domain_id}/groups/{group_id}/roles/{role_id}/inherited_to_projects</em></pre>
</li></ul>
</div>
<div class="section" id="iam_02_0519__section8667210111114"><h4 class="sectiontitle">Response Parameters</h4><p id="iam_02_0519__p1066714103119">None</p>
</div>
<div class="section" id="iam_02_0519__section4278193613324"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0519__en-us_topic_0032920307_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0519__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="iam_02_0519__en-us_topic_0032920307_p51565323">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.2"><p id="iam_02_0519__en-us_topic_0032920307_p16041657">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0519__en-us_topic_0032920307_row24305815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0519__en-us_topic_0032920307_p22613965">204</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0519__p1871052711400">The request is successful.</p>
</td>
</tr>
<tr id="iam_02_0519__en-us_topic_0032920307_row43909159"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0519__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="iam_02_0519__en-us_topic_0032920307_p56751409">The server failed to process the request.</p>
</td>
</tr>
<tr id="iam_02_0519__row460808479497"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0519__p120744399497">401</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0519__p385055099497">Authentication failed.</p>
</td>
</tr>
<tr id="iam_02_0519__row652024833911"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0519__p17521104893912">403</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0519__p115211448183917">Access denied.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845579.html">Permission Management</a></div>
</div>
</div>