doc-exports/docs/iam/api-ref/en-us_topic_0057845591.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

509 lines
45 KiB
HTML

<a name="en-us_topic_0057845591"></a><a name="en-us_topic_0057845591"></a>
<h1 class="topictitle1">Querying a Role List</h1>
<div id="body1492670576144"><div class="section" id="en-us_topic_0057845591__section495175389414"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845591__p1592814572714">This API is used to query a role list, including the permissions policies of a role. A role is a set of permissions and represents a group of actions.</p>
</div>
<div class="section" id="en-us_topic_0057845591__section997983010214"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1882118218385">GET /v3/roles</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845591__en-us_topic_0222037529_table28244219386" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Query parameters</caption><thead align="left"><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1182316211386"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.5.1.1"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p6825152193819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.2.3.2.5.1.2"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p108251327386">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.2%" id="mcps1.3.2.3.2.5.1.3"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1182616283814">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.8%" id="mcps1.3.2.3.2.5.1.4"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p3826425384">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1823112163810"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p12826727388">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p108273243818">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.2%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p582722103819">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.8%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p982882123815">Domain ID.</p>
<div class="note" id="en-us_topic_0057845591__en-us_topic_0222037529_note108298211388"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="en-us_topic_0057845591__en-us_topic_0222037529_ul148302213819"><li id="en-us_topic_0057845591__en-us_topic_0222037529_li283019243810">If this parameter is specified, only custom policies of the account will be returned.</li><li id="en-us_topic_0057845591__en-us_topic_0222037529_li283117217388">If this parameter is not specified, all system permissions (including system-defined policies and roles) will be returned.</li></ul>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1982320213389"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p18831924388">name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p168320211388">No</p>
</td>
<td class="cellrowborder" valign="top" width="10.2%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p68321273812">String</p>
</td>
<td class="cellrowborder" valign="top" width="64.8%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p88326217389">Permission name for internal use. It may be different from the <strong id="en-us_topic_0057845591__b1531045104720">display_name</strong> displayed on the console.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-us_topic_0057845591__section445914536313"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845591__en-us_topic_0222037529_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1883412233813"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.1"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p18349283819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.5.1.2"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p118359213812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.5.1.3"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p483511233818">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="65%" id="mcps1.3.3.2.2.5.1.4"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p158366203811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row483413216388"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p10836322383">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1183618213816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p12837182123812">String</p>
</td>
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p9837327380">Fill <strong id="en-us_topic_0057845591__b1397844716501">application/json;charset=utf8</strong> in this field.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row188341124385"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p48371429387">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p178381823388">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p8838325382">String</p>
</td>
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1583913223815">Token with <strong id="en-us_topic_0057845591__b386061014514">Security Administrator</strong> permissions.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-us_topic_0057845591__section2676734415"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845591__en-us_topic_0222037529_responseParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response body</caption><thead align="left"><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row384012212383"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.2.4.1.1"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p3841192163812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.2.4.1.2"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p16841172113812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.2.2.4.1.3"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p48421325386">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row58403213815"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p18842112183817"><a href="#en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101Links">links</a></p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p784232163812">Object</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1284320263811">Resource link information.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row184072143818"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p17843192183814"><a href="#en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritem">roles</a></p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p284442103815">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p28445213813">Permission information.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__row096455123918"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.4.1.1 "><p id="en-us_topic_0057845591__p1910515411356">total_number</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.4.1.2 "><p id="en-us_topic_0057845591__p4105154123517">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.2.4.1.3 "><p id="en-us_topic_0057845591__p171061254133510">Total number of permissions.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101Links"></a><a name="en-us_topic_0222037529_response_Rs101Links"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101Links" frame="border" border="1" rules="all"><caption><b>Table 4 </b>links</caption><thead align="left"><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row158455214389"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.3.2.4.1.1"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p78456213389">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.3.2.4.1.2"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p128467216387">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.3.2.4.1.3"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p084642193816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row10845142113819"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1584614211388">self</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p19847172113817">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p9847122173819">Resource link.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1084592113810"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p08487211382">previous</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1084882143814">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p584819273812">Previous resource link.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row188451222383"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1084920216385">next</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p15849172123810">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p128498223813">Next resource link.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritem"></a><a name="en-us_topic_0222037529_response_Rs101RolesArritem"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritem" frame="border" border="1" rules="all"><caption><b>Table 5 </b>roles</caption><thead align="left"><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row085015217386"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.4.2.4.1.1"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p185162173814">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.4.2.4.1.2"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p185212212384">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.4.2.4.1.3"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p118523212386">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row18506273814"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p16852172193812">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p17853122133816">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p148534214383">ID of the domain to which the permission belongs.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row185017293815"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p2085414253819">flag</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1385417211386">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p98541024384">If this parameter is set to <strong id="en-us_topic_0057845591__b84951235155216">fine_grained</strong>, the permission is a system-defined policy.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1285019217387"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p885510218383">description_cn</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p885592173816">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p5855182103815">Description of the permission in Chinese.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1985032133812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p168563253814">catalog</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p385662103811">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p68576216386">Service catalog of the permission.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1850102173812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p78579215380">name</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1585872123813">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1485812273811">Permission name. This parameter is carried in the token of a user. The cloud service determines whether the user has the access permission based on the role name.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row68503213382"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p38580273817">description</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p6859326385">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1285912183813">Description of the permission.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row285011243817"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p485911217384"><a href="#en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemLinks">links</a></p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p3860142193820">Object</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1286082123814">Permission resource link.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row148501327381"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1086010263810">id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p0861172123810">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1861172143815">Permission ID.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row108508212389"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p9862626382">display_name</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p18862142183810">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1286219219383">Display name of the permission.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row18850172163812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1686313211387">type</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p3863525381">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p148633213389">Display mode of the permission.</p>
<div class="note" id="en-us_topic_0057845591__en-us_topic_0222037529_note158645211382"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="en-us_topic_0057845591__en-us_topic_0222037529_ul18865102173816"><li id="en-us_topic_0057845591__en-us_topic_0222037529_li4865122183811"><strong id="en-us_topic_0057845591__b04181165319">AX</strong>: Account level.</li><li id="en-us_topic_0057845591__en-us_topic_0222037529_li0866152203816"><strong id="en-us_topic_0057845591__b4579712175311">XA</strong>: Project level.</li><li id="en-us_topic_0057845591__en-us_topic_0222037529_li11866112153812"><strong id="en-us_topic_0057845591__b18941191355316">AA</strong>: Both the account level and project level.</li><li id="en-us_topic_0057845591__en-us_topic_0222037529_li18866122183816"><strong id="en-us_topic_0057845591__b18248315145314">XX</strong>: Neither the account level nor project level.</li><li id="en-us_topic_0057845591__en-us_topic_0222037529_li1986762103812">The display mode of a custom policy can only be <strong id="en-us_topic_0057845591__b17951775313">AX</strong> or <strong id="en-us_topic_0057845591__b29151712534">XA</strong>. A custom policy must be displayed at either of the two levels.</li></ul>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row98501223385"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p178671216384"><a href="#en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemPolicy">policy</a></p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p188686211382">Object</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p986832113810">Content of the permission.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row88501253810"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p15868124388">updated_time</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1486914217384">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p98697233812">Time when the permission was last updated.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row785012283812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p148691425386">created_time</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p787010233811">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.4.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p58705217382">Time when the permission was created.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemLinks"></a><a name="en-us_topic_0222037529_response_Rs101RolesArritemLinks"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemLinks" frame="border" border="1" rules="all"><caption><b>Table 6 </b>roles.links</caption><thead align="left"><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row5871327389"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.5.2.4.1.1"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1787142133817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.5.2.4.1.2"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p108726217388">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.5.2.4.1.3"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1887232113816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row487172163814"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.5.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1687310220382">self</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.5.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1687310211384">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.5.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p08735283817">Resource link.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1287132143816"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.5.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p587416211389">previous</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.5.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p88742022384">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.5.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p18741621387">Previous resource link.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row208714215387"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.5.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1887512293815">next</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.5.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1687514223810">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.5.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p287516293817">Next resource link.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemPolicy"></a><a name="en-us_topic_0222037529_response_Rs101RolesArritemPolicy"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemPolicy" frame="border" border="1" rules="all"><caption><b>Table 7 </b>roles.policy</caption><thead align="left"><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row13876162183817"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.6.2.4.1.1"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p38771722380">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.6.2.4.1.2"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p17877142123819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.6.2.4.1.3"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p887782123813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row18876142173813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.6.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p78786283813"><a href="#en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemPolicyDependsArritem">Depends</a></p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.6.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1287812113814">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.6.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1087962143810">Dependence permissions.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row187618216380"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.6.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p158797223811"><a href="#en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemPolicyStatementArritem">Statement</a></p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.6.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p12880132153814">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.6.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1088019212387">Statement of the permission.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row158761273815"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.6.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p118808219384">Version</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.6.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p18881192173814">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.6.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1188119211383">Permission version.</p>
<div class="note" id="en-us_topic_0057845591__en-us_topic_0222037529_note17882192113816"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="en-us_topic_0057845591__en-us_topic_0222037529_ul198821212388"><li id="en-us_topic_0057845591__en-us_topic_0222037529_li6883825387"><strong id="en-us_topic_0057845591__b561611016543">1.0</strong>: System-defined role. Only a limited number of service-level roles are provided for authorization.</li><li id="en-us_topic_0057845591__en-us_topic_0222037529_li1688311216384"><strong id="en-us_topic_0057845591__b1052142715419">1.1</strong>: Policy. A policy defines the permissions required to perform operations on a specific cloud resource under certain conditions.</li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemPolicyDependsArritem"></a><a name="en-us_topic_0222037529_response_Rs101RolesArritemPolicyDependsArritem"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemPolicyDependsArritem" frame="border" border="1" rules="all"><caption><b>Table 8 </b>roles.policy.Depends</caption><thead align="left"><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row5884142123815"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.7.2.4.1.1"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p48847217382">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.7.2.4.1.2"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p488517263813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.7.2.4.1.3"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1688511210387">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1988472173819"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.7.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p388502193812">catalog</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.7.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p78861243813">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.7.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p128861211381">Service catalog of the permission.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1988442173816"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.7.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p688682193812">display_name</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.7.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p118871824386">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.7.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p188878213818">Display name of the permission.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemPolicyStatementArritem"></a><a name="en-us_topic_0222037529_response_Rs101RolesArritemPolicyStatementArritem"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemPolicyStatementArritem" frame="border" border="1" rules="all"><caption><b>Table 9 </b>roles.policy.Statement</caption><thead align="left"><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row12888628384"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.8.2.4.1.1"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p188812218386">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.8.2.4.1.2"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p12889229387">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.8.2.4.1.3"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p388917217388">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1288816214385"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.8.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p168901420383">Action</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.8.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p138901122384">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.8.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p18901127381">Specific operation permission on a resource. A maximum of 100 actions are allowed.</p>
<div class="note" id="en-us_topic_0057845591__en-us_topic_0222037529_note7891172113817"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="en-us_topic_0057845591__en-us_topic_0222037529_ul198929211384"><li id="en-us_topic_0057845591__en-us_topic_0222037529_li1289212215385">The value format is <em id="en-us_topic_0057845591__i16986639145716">Service name</em>:<em id="en-us_topic_0057845591__i17994439155711">Resource type</em>:<em id="en-us_topic_0057845591__i199453925718">Operation</em>, for example, <strong id="en-us_topic_0057845591__b59941339145716">vpc:ports:create</strong>.</li><li id="en-us_topic_0057845591__en-us_topic_0222037529_li1989202143819"><em id="en-us_topic_0057845591__i12967194685720">Service name</em>: indicates the product name, such as <strong id="en-us_topic_0057845591__b1397314460575">ecs</strong>, <strong id="en-us_topic_0057845591__b8973164645715">evs</strong>, or <strong id="en-us_topic_0057845591__b209741646135717">vpc</strong>. Only lowercase letters are allowed. Resource types and operations are not case-sensitive. You can use an asterisk (*) to represent all operations.</li><li id="en-us_topic_0057845591__en-us_topic_0222037529_li168921627389">For a custom agency policy, this parameter should be set to <em id="en-us_topic_0057845591__i16676126585">"Action": ["iam:agencies:assume"]</em>.</li></ul>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1988816273820"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.8.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p0893229385">Effect</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.8.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p089314213814">String</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.8.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p7894928389">Effect of the permission. The value can be <strong id="en-us_topic_0057845591__b13081205583">Allow</strong> or <strong id="en-us_topic_0057845591__b331532015585">Deny</strong>. If both Allow and Deny statements are found in a policy, the authentication starts from the Deny statements.</p>
<p id="en-us_topic_0057845591__en-us_topic_0222037529_p19894922385">Options:</p>
<ul id="en-us_topic_0057845591__en-us_topic_0222037529_ul5894626382"><li id="en-us_topic_0057845591__en-us_topic_0222037529_li78943233813">Allow</li><li id="en-us_topic_0057845591__en-us_topic_0222037529_li1589514218388">Deny</li></ul>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row1288815211385"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.8.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p0896726380">Condition</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.8.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p158964253813">Object</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.8.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1389717219389">Conditions for the permission to take effect. A maximum of 10 conditions are allowed.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0222037529_row118882211387"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.8.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p118971025385">Resource</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.8.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p98981421388">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.8.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p3898132153811">Cloud resource. The array can contain a maximum of 10 resource strings, and each string cannot exceed 128 characters.</p>
<div class="note" id="en-us_topic_0057845591__en-us_topic_0222037529_note18991626384"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="en-us_topic_0057845591__en-us_topic_0222037529_ul179003213387"><li id="en-us_topic_0057845591__en-us_topic_0222037529_li179003213387">Format: <em id="en-us_topic_0057845591__i389054711588">::::</em>. For example, <strong id="en-us_topic_0057845591__b1189619475585">obs:</strong><strong id="en-us_topic_0057845591__b1389754705817"><em id="en-us_topic_0057845591__i1489711478585">:</em></strong><strong id="en-us_topic_0057845591__b1989764745818">:bucket:*</strong>. Asterisks are allowed.</li><li id="en-us_topic_0057845591__en-us_topic_0222037529_li14900142203814">The region segment can be <strong id="en-us_topic_0057845591__b772315562589">*</strong> or a region accessible to the user. The specified resource must belong to the corresponding service that actually exists.</li><li id="en-us_topic_0057845591__en-us_topic_0222037529_li09009243819">In the case of a custom policy for agencies, the type of this parameter is object, and the value should be set to <em id="en-us_topic_0057845591__i210420785911">"Resource": {"uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]}</em>.</li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845591__en-us_topic_0222037529_response_Rs101RolesArritemPolicyStatementArritemConditionOperator" frame="border" border="1" rules="all"><caption><b>Table 10 </b>roles.policy.Statement.Condition.operator</caption><thead align="left"><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row109051927386"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.9.2.4.1.1"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1790519243815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.9.2.4.1.2"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p4906102133811">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.9.2.4.1.3"><p id="en-us_topic_0057845591__en-us_topic_0222037529_p15906172163810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845591__en-us_topic_0222037529_row190520253817"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.9.2.4.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p1990717216387">attribute</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.9.2.4.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p584314385">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.9.2.4.1.3 "><p id="en-us_topic_0057845591__en-us_topic_0222037529_p9853143819">Condition key. The condition key must correspond to the specified operator. A maximum of 10 condition keys are allowed.</p>
<p id="en-us_topic_0057845591__en-us_topic_0222037529_p17904171019218">The parameter type is custom character string array.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-us_topic_0057845591__en-us_topic_0222037529_section1991310381"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="en-us_topic_0057845591__en-us_topic_0222037529_screen392312388">GET https://sample.domain.com/v3/roles</pre>
</div>
<div class="section" id="en-us_topic_0057845591__en-us_topic_0222037529_section13919313812"><h4 class="sectiontitle">Example Response</h4><p id="en-us_topic_0057845591__en-us_topic_0222037529_p19915317386"><strong id="en-us_topic_0057845591__b10145612504">Status code: 200</strong></p>
<p id="en-us_topic_0057845591__en-us_topic_0222037529_p1691734383">The request is successful.</p>
<pre class="screen" id="en-us_topic_0057845591__screen1812855493519">{
"roles" : [ {
"domain_id" : null,
"description_cn" : "Description of the permission in Chinese",
"catalog" : "VulnScan",
"name" : "wscn_adm",
"description" : "Vulnerability Scan Service administrator of tasks and reports.",
"links" : {
"next" : null,
"previous" : null,
"self" : "https://sample.domain.com/v3/roles/0af84c1502f447fa9c2fa18083fbb..."
},
"id" : "0af84c1502f447fa9c2fa18083fbb...",
"display_name" : "VSS Administrator",
"type" : "XA",
"policy" : {
"Version" : "1.0",
"Statement" : [ {
"Action" : [ "WebScan:*:*" ],
"Effect" : "Allow"
} ],
"Depends" : [ {
"catalog" : "BASE",
"display_name" : "Server Administrator"
}, {
"catalog" : "BASE",
"display_name" : "Tenant Guest"
} ]
}
}, {
"domain_id" : null,
"flag" : "fine_grained",
"description_cn" : "Description of the permission in Chinese",
"catalog" : "CSE",
"name" : "system_all_34",
"description" : "All permissions of CSE service.",
"links" : {
"next" : null,
"previous" : null,
"self" : "https://sample.domain.com/v3/roles/0b5ea44ebdc64a24a9c372b2317f7..."
},
"id" : "0b5ea44ebdc64a24a9c372b2317f7...",
"display_name" : "CSE Admin",
"type" : "XA",
"policy" : {
"Version" : "1.1",
"Statement" : [ {
"Action" : [ "cse:*:*", "ecs:*:*", "evs:*:*", "vpc:*:*" ],
"Effect" : "Allow"
} ]
}
} ],
"links" : {
"next" : null,
"previous" : null,
"self" : "https://sample.domain.com/v3/roles"
},
"total_number" : 300
}</pre>
</div>
<div class="section" id="en-us_topic_0057845591__section5556784894735"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845591__en-us_topic_0032920307_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845591__en-us_topic_0032920307_row10578662"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.7.2.1.3.1.1"><p id="en-us_topic_0057845591__en-us_topic_0032920307_p51565323"><strong id="en-us_topic_0057845591__b23486412155652">Status Code</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.7.2.1.3.1.2"><p id="en-us_topic_0057845591__en-us_topic_0032920307_p16041657"><strong id="en-us_topic_0057845591__b20601766145329_9">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845591__en-us_topic_0032920307_row24305815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0032920307_p22613965">200</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0032920307_p19791876">The request is successful.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0032920307_row43909159"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0032920307_p66980994">400</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0032920307_p56751409">The server failed to process the request.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__row460808479497"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.1 "><p id="en-us_topic_0057845591__p120744399497">401</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.2 "><p id="en-us_topic_0057845591__p385055099497">Authentication failed.</p>
</td>
</tr>
<tr id="en-us_topic_0057845591__en-us_topic_0032920307_row41000636"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.1 "><p id="en-us_topic_0057845591__en-us_topic_0032920307_p32717189">403</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.7.2.1.3.1.2 "><p id="en-us_topic_0057845591__en-us_topic_0032920307_p32846614">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>