IAM API 2.0.38

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
This commit is contained in:
zhangyue 2022-10-26 04:31:24 +00:00 committed by zuul
parent cafab15810
commit 3b5a58b1fe
191 changed files with 36014 additions and 0 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,3 @@
version=""
language="en-us"
type=""

Binary file not shown.

After

Width:  |  Height:  |  Size: 155 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,19 @@
<a name="en-us_topic_0057845565"></a><a name="en-us_topic_0057845565"></a>
<h1 class="topictitle1">Token</h1>
<div id="body1492676120062"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0057845629.html">Obtaining an Unscoped Token (SP Initiated)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_02_0003.html">Obtaining an Unscoped Token (IdP Initiated)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_13_0604.html">Obtaining a Scoped Token</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845573.html">Federated Identity Authentication Management</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,29 @@
<a name="en-us_topic_0057845573"></a><a name="en-us_topic_0057845573"></a>
<h1 class="topictitle1">Federated Identity Authentication Management</h1>
<div id="body1492676120062"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0057845646.html">Obtaining a Token in Federated Identity Authentication Mode</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845605.html">Identity Provider</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845588.html">Mapping</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845619.html">Protocol</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845607.html">Metadata</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845565.html">Token</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845633.html">Domain</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845643.html">Project</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="iam_20_0000.html">APIs</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,41 @@
<a name="en-us_topic_0057845579"></a><a name="en-us_topic_0057845579"></a>
<h1 class="topictitle1">Permission Management</h1>
<div id="body1492670575915"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0057845591.html">Querying a Role List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845603.html">Querying Role Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_11_0003.html">Querying Role Assignments</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845571.html">Querying Permissions of a User Group Under a Domain</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845640.html">Querying Permissions of a User Group Corresponding to a Project</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845623.html">Granting Permissions to a User Group of a Domain</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845597.html">Granting Permissions to a User Group Corresponding to a Project</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845572.html">Deleting Permissions of a User Group Corresponding to a Project</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845560.html">Deleting Permissions of a User Group of a Domain</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845632.html">Querying Whether a User Group Under a Domain Has Specific Permissions</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845620.html">Querying Whether a User Group Corresponding to a Project Has Specific Permissions</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_10_0013.html">Removing Specified Permissions of a User Group in All Projects</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_10_0012.html">Checking Whether a User Group Has Specified Permissions for All Projects</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_10_0011.html">Querying All Permissions of a User Group</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="iam_20_0000.html">APIs</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,84 @@
<a name="en-us_topic_0057845586"></a><a name="en-us_topic_0057845586"></a>
<h1 class="topictitle1">Verifying a Token</h1>
<div id="body1602765747314"><div class="section" id="en-us_topic_0057845586__section757173854518"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845586__p131681838174514">This API can be used by the administrator to verify the token of a user or used by a user to verify their token. The administrator can only verify the token of a user created using the account. If the verified token is valid, <strong id="en-us_topic_0057845586__b3961122204317">200</strong> is displayed.</p>
</div>
<div class="section" id="en-us_topic_0057845586__section166083812459"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0057845586__p316853874510">HEAD /v3/auth/tokens</p>
</div>
<div class="section" id="en-us_topic_0057845586__section1360123815455"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845586__table1961138104518" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the request header</caption><thead align="left"><tr id="en-us_topic_0057845586__row71681738124513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="en-us_topic_0057845586__p1316814388458">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_0057845586__p21681838174512">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="en-us_topic_0057845586__p1816893844518">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.5.1.4"><p id="en-us_topic_0057845586__p14168538184512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845586__row8168193813457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en-us_topic_0057845586__p1916843834516">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_0057845586__p51681538124520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en-us_topic_0057845586__p316813854516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><ul id="en-us_topic_0057845586__ul1963814299291"><li id="en-us_topic_0057845586__li176391829162917">To verify your own token, specify your token. There are no special requirements on the permissions that your token must have.</li><li id="en-us_topic_0057845586__li11639192962916">To verify the token of another user under the same domain, use a token that has permissions of the <strong id="en-us_topic_0057845586__b2069775420254">Security Administrator</strong> policy.</li></ul>
</td>
</tr>
<tr id="en-us_topic_0057845586__row21687383455"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="en-us_topic_0057845586__p1016893884514">X-Subject-Token</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="en-us_topic_0057845586__p1116833813459">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="en-us_topic_0057845586__p181681387457">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="en-us_topic_0057845586__p19168638114520">Token to be verified.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-us_topic_0057845586__section1371238114514"><h4 class="sectiontitle">Response Parameters</h4><p id="en-us_topic_0057845586__p181680389451">None</p>
</div>
<div class="section" id="en-us_topic_0057845586__section7722384454"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="en-us_topic_0057845586__screen201688383457">curl -i -k -H "X-Auth-Token:$token" -H "X-Subject-Token:$token" -X HEAD https://sample.domain.com/v3/auth/tokens</pre>
</div>
<div class="section" id="en-us_topic_0057845586__section77303810458"><h4 class="sectiontitle">Example Response</h4><p id="en-us_topic_0057845586__p1916813384455">None</p>
</div>
<div class="section" id="en-us_topic_0057845586__section074113864511"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845586__table774238124510" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845586__row13168138134517"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="en-us_topic_0057845586__p1616933812456">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="en-us_topic_0057845586__p18169113812459">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057845586__row101691338164515"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="en-us_topic_0057845586__p316983814512">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="en-us_topic_0057845586__p9561111611495">The request is successful.</p>
</td>
</tr>
<tr id="en-us_topic_0057845586__row201691638124510"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="en-us_topic_0057845586__p3169183854511">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="en-us_topic_0057845586__p19371432154917">Authentication failed.</p>
</td>
</tr>
<tr id="en-us_topic_0057845586__row616933834519"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="en-us_topic_0057845586__p1816923834511">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="en-us_topic_0057845586__p1939913256494">The requested resource cannot be found.</p>
</td>
</tr>
<tr id="en-us_topic_0057845586__row41699388458"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="en-us_topic_0057845586__p14169133816453">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="en-us_topic_0057845586__p31698384455">The system is abnormal.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845626.html">Token Management</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,23 @@
<a name="en-us_topic_0057845588"></a><a name="en-us_topic_0057845588"></a>
<h1 class="topictitle1">Mapping</h1>
<div id="body1492676120170"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0057845567.html">Querying the Mapping List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845645.html">Querying a Mapping</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845590.html">Creating a Mapping</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845568.html">Updating a Mapping</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845648.html">Deleting a Mapping</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845573.html">Federated Identity Authentication Management</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,55 @@
<a name="en-us_topic_0057845593"></a><a name="en-us_topic_0057845593"></a>
<h1 class="topictitle1">User Management</h1>
<div id="body1492670575915"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0057845638.html">Querying a User List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845652.html">Querying User Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0004.html">Querying User Details (Recommended)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845554.html">Querying the User Group to Which a User Belongs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845561.html">Querying Users in a User Group</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845637.html">Creating a User</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845653.html">Changing a Password</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845611.html">Modifying User Information</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0011.html">Modifying User Information (Including Email Address and Mobile Number)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845630.html">Deleting a User</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845601.html">Deleting a User from a User Group</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0012.html">Querying MFA Device Information of Users</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0013.html">Querying the MFA Device Information of a User</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0014.html">Querying Login Protection Configurations of Users</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0016.html">Querying the Login Protection Configuration of a User</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0019.html">Creating a Virtual MFA Device</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0020.html">Deleting a Virtual MFA Device</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0017.html">Binding a Virtual MFA Device</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0018.html">Unbinding a Virtual MFA Device</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0021.html">Modifying the Login Protection Configuration of a User</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_08_0025.html">Sending a Welcome Email to a User</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="iam_20_0000.html">APIs</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,23 @@
<a name="en-us_topic_0057845604"></a><a name="en-us_topic_0057845604"></a>
<h1 class="topictitle1">Services and Endpoints</h1>
<div id="body1492670575915"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0057845587.html">Querying Services</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0067148045.html">Querying Service Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845562.html">Querying Endpoints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0067148046.html">Querying Endpoint Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_02_0004.html">Querying the Service Catalog</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="iam_20_0000.html">APIs</a></div>
</div>
</div>

View File

@ -0,0 +1,23 @@
<a name="en-us_topic_0057845605"></a><a name="en-us_topic_0057845605"></a>
<h1 class="topictitle1">Identity Provider</h1>
<div id="body1492676120163"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0057845581.html">Querying the Identity Provider List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845639.html">Querying an Identity Provider</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845606.html">Creating a SAML Identity Provider</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845612.html">Updating a SAML Identity Provider</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057845570.html">Deleting an Identity Provider</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845573.html">Federated Identity Authentication Management</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More