vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

IAM API 1108 Version

Browse Source 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: weihongmin1 <weihongmin1@huawei.com>
Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
This commit is contained in:
Wei, Hongmin 2024-12-03 20:42:07 +00:00 committed by zuul
parent f14bb7d85a
commit ca9b774f3d
14 changed files with 886 additions and 969 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

467
docs/iam/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

751
docs/iam/api-ref/CLASS.TXT.json
View File

File diff suppressed because it is too large Load Diff

0
docs/iam/api-ref/en-us_image_0000001782066216.png → docs/iam/api-ref/en-us_image_0000002089066209.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 77 KiB

186
docs/iam/api-ref/en-us_topic_0057845564.html
View File

File diff suppressed because it is too large Load Diff

29
docs/iam/api-ref/en-us_topic_0057845582.html
View File

@ -1,19 +1,20 @@
<a name="en-us_topic_0057845582"></a><a name="en-us_topic_0057845582"></a>
<h1 class="topictitle1">Before You Start</h1>
<div id="body1559099328159"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="iam_01_0002.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_01_0003.html">API Calling</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_01_0004.html">Endpoints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_01_0005.html">Constraints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_01_0007.html">Concepts</a></strong><br>
</li>
</ul>
<div id="body1559099328159"><p id="en-us_topic_0057845582__p69411147192617">Welcome to Identity and Access Management (IAM). IAM provides identity authentication, permissions management, and access control. With IAM, you can create and manage users and grant them permissions to allow or deny their access to cloud resources.</p>
<p id="en-us_topic_0057845582__p10374173263913">You can use IAM through the console or application programming interfaces (APIs). This document describes how to use APIs to perform operations on IAM, such as creating users and user groups and obtaining tokens.</p>
<div class="section" id="en-us_topic_0057845582__section1197415281618"><h4 class="sectiontitle">Endpoints</h4><p id="en-us_topic_0057845582__p196710110567">An endpoint is the <strong id="en-us_topic_0057845582__b1167612563">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</div>
<div class="section" id="en-us_topic_0057845582__section5340814217"><h4 class="sectiontitle">Concepts</h4><p id="en-us_topic_0057845582__p94268196410">Common concepts used when you call IAM APIs are described as follows:</p>
<ul id="en-us_topic_0057845582__ul10222098514"><li id="en-us_topic_0057845582__li16222991250">Account<p id="en-us_topic_0057845582__p5222792519"><a name="en-us_topic_0057845582__li16222991250"></a><a name="li16222991250"></a>An account is created upon successful registration with the cloud platform. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions.</p>
</li><li id="en-us_topic_0057845582__li14222491858">User<p id="en-us_topic_0057845582__p92221591154"><a name="en-us_topic_0057845582__li14222491858"></a><a name="li14222491858"></a>A user is created by a domain to use cloud services. Each user has its own identity credentials (password or access keys).</p>
<p id="en-us_topic_0057845582__p62227915513">An IAM user can view the domain ID and user ID on the <strong id="en-us_topic_0057845582__b1234134916402">My Credentials</strong> page of the console. The domain name, username, and password will be required for API authentication.</p>
</li><li id="en-us_topic_0057845582__li192226919516">Region<p id="en-us_topic_0057845582__p72229918514"><a name="en-us_topic_0057845582__li192226919516"></a><a name="li192226919516"></a>A region contains a physical data center, which is completely isolated to improve fault tolerance and stability. The region that is selected during resource creation cannot be changed after the resource is created. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.</p>
</li><li id="en-us_topic_0057845582__li132221991515">AZ<p id="en-us_topic_0057845582__p16326155631513"><a name="en-us_topic_0057845582__li132221991515"></a><a name="li132221991515"></a>An AZ is a physical location where resources use independent power supplies and networks. A region contains one or more AZs that are physically isolated but interconnected through internal networks. Because AZs are isolated from each other, any fault that occurs in an AZ will not affect other AZs.</p>
</li><li id="en-us_topic_0057845582__li722289759">Project<p id="en-us_topic_0057845582__p18222189059"><a name="en-us_topic_0057845582__li722289759"></a><a name="li722289759"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and create resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.</p>
<div class="fignone" id="en-us_topic_0057845582__fig102228919519"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="en-us_topic_0057845582__image11166785463" src="en-us_image_0000002089066209.png"></span></div>
</li></ul>
</div>
</div>
<div></div>

12
docs/iam/api-ref/iam_01_0002.html
View File

@ -1,12 +0,0 @@
<a name="iam_01_0002"></a><a name="iam_01_0002"></a>
<h1 class="topictitle1">Overview</h1>
<div id="body1602509999536"><p id="iam_01_0002__p69411147192617">Welcome to Identity and Access Management (IAM). IAM provides identity authentication, permissions management, and access control. With IAM, you can create and manage users and grant them permissions to allow or deny their access to cloud resources.</p>
<p id="iam_01_0002__p10374173263913">You can use IAM through the console or application programming interfaces (APIs). This document describes how to use APIs to perform operations on IAM, such as creating users and user groups and obtaining tokens.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845582.html">Before You Start</a></div>
</div>
</div>

11
docs/iam/api-ref/iam_01_0003.html
View File

@ -1,11 +0,0 @@
<a name="iam_01_0003"></a><a name="iam_01_0003"></a>
<h1 class="topictitle1">API Calling</h1>
<div id="body1602552416062"><p id="iam_01_0003__p8060118">IAM supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see <a href="iam_02_0000.html">Calling APIs</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845582.html">Before You Start</a></div>
</div>
</div>

11
docs/iam/api-ref/iam_01_0004.html
View File

@ -1,11 +0,0 @@
<a name="iam_01_0004"></a><a name="iam_01_0004"></a>
<h1 class="topictitle1">Endpoints</h1>
<div id="body1602509999536"><p id="iam_01_0004__p196710110567">An endpoint is the <strong id="iam_01_0004__b179981015162319">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845582.html">Before You Start</a></div>
</div>
</div>

111
docs/iam/api-ref/iam_01_0005.html
View File

File diff suppressed because it is too large Load Diff

20
docs/iam/api-ref/iam_01_0007.html
View File

@ -1,20 +0,0 @@
<a name="iam_01_0007"></a><a name="iam_01_0007"></a>
<h1 class="topictitle1">Concepts</h1>
<div id="body1602509999536"><p id="iam_01_0007__p94268196410">Common concepts used when you call IAM APIs are described as follows:</p>
<ul id="iam_01_0007__ul10222098514"><li id="iam_01_0007__li16222991250">Account<p id="iam_01_0007__p5222792519"><a name="iam_01_0007__li16222991250"></a><a name="li16222991250"></a>An account is created upon successful registration with the cloud platform. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions.</p>
</li><li id="iam_01_0007__li107043349394">Domain<p id="iam_01_0007__p1270493415392"><a name="iam_01_0007__li107043349394"></a><a name="li107043349394"></a>A domain, also called an "account", is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions.</p>
</li><li id="iam_01_0007__li14222491858">User<p id="iam_01_0007__p92221591154"><a name="iam_01_0007__li14222491858"></a><a name="li14222491858"></a>A user is created using a domain to use cloud services. Each user has their own identity credentials (password and access keys).</p>
<p id="iam_01_0007__p62227915513">An IAM user can view the domain ID and user ID on the <strong id="iam_01_0007__b1365520564419">My Credentials</strong> page of the console. The account name, username, and password will be required for API authentication.</p>
</li><li id="iam_01_0007__li192226919516">Region<p id="iam_01_0007__p72229918514"><a name="iam_01_0007__li192226919516"></a><a name="li192226919516"></a>A region contains a physical data center, which is completely isolated to improve fault tolerance and stability. The region that is selected during resource creation cannot be changed after the resource is created. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.</p>
</li><li id="iam_01_0007__li132221991515">AZ<p id="iam_01_0007__p16326155631513"><a name="iam_01_0007__li132221991515"></a><a name="li132221991515"></a>An AZ is a physical location where resources use independent power supplies and networks. A region contains one or more AZs that are physically isolated but interconnected through internal networks. Because AZs are isolated from each other, any fault that occurs in an AZ will not affect other AZs.</p>
</li><li id="iam_01_0007__li722289759">Project<p id="iam_01_0007__p18222189059"><a name="iam_01_0007__li722289759"></a><a name="li722289759"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and create resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.</p>
<div class="fignone" id="iam_01_0007__fig102228919519"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="iam_01_0007__image11166785463" src="en-us_image_0000001782066216.png" width="NaN" height="NaN"></span></div>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845582.html">Before You Start</a></div>
</div>
</div>

57
docs/iam/api-ref/iam_01_0008.html
View File

@ -223,6 +223,11 @@
<td class="cellrowborder" valign="top" width="71.23%" headers="mcps1.3.6.2.1.3.1.2 "><p id="iam_01_0008__p1379942961316">Provided for the administrator to query the users in a user group.</p>
</td>
</tr>
<tr id="iam_01_0008__row1818759185816"><td class="cellrowborder" valign="top" width="28.77%" headers="mcps1.3.6.2.1.3.1.1 "><p id="iam_01_0008__p518175965813"><a href="iam_08_0015.html">Creating an IAM User (Recommended)</a></p>
</td>
<td class="cellrowborder" valign="top" width="71.23%" headers="mcps1.3.6.2.1.3.1.2 "><p id="iam_01_0008__p1118125975814">Provided for the administrator to create a user.</p>
</td>
</tr>
<tr id="iam_01_0008__row131546201819"><td class="cellrowborder" valign="top" width="28.77%" headers="mcps1.3.6.2.1.3.1.1 "><p id="iam_01_0008__p15321346171817"><a href="en-us_topic_0057845637.html">Creating a User</a></p>
</td>
<td class="cellrowborder" valign="top" width="71.23%" headers="mcps1.3.6.2.1.3.1.2 "><p id="iam_01_0008__p361553161911">Create a user under a domain.</p>
@ -517,6 +522,26 @@
<td class="cellrowborder" valign="top" width="69.75%" headers="mcps1.3.10.2.1.3.1.2 "><p id="iam_01_0008__p142831240121410">Delete permissions of an agency on a domain.</p>
</td>
</tr>
<tr id="iam_01_0008__row499216583479"><td class="cellrowborder" valign="top" width="30.25%" headers="mcps1.3.10.2.1.3.1.1 "><p id="iam_01_0008__p633231355917"><a href="iam_02_0040.html">Querying All Permissions of an Agency</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.75%" headers="mcps1.3.10.2.1.3.1.2 "><p id="iam_01_0008__p1233210132592">Provided for the administrator to query all permissions that have been assigned to an agency.</p>
</td>
</tr>
<tr id="iam_01_0008__row12993155812478"><td class="cellrowborder" valign="top" width="30.25%" headers="mcps1.3.10.2.1.3.1.1 "><p id="iam_01_0008__p20331101365916"><a href="iam_02_0041.html">Granting Specified Permissions to an Agency for All Projects</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.75%" headers="mcps1.3.10.2.1.3.1.2 "><p id="iam_01_0008__p15331413105918">Provided for the administrator to grant specified permissions to an agency for all projects.</p>
</td>
</tr>
<tr id="iam_01_0008__row1799395874716"><td class="cellrowborder" valign="top" width="30.25%" headers="mcps1.3.10.2.1.3.1.1 "><p id="iam_01_0008__p10331413175917"><a href="iam_02_0042.html">Checking Whether an Agency Has Specified Permissions</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.75%" headers="mcps1.3.10.2.1.3.1.2 "><p id="iam_01_0008__p143311013115911">Provided for the administrator to check whether an agency has specified permissions.</p>
</td>
</tr>
<tr id="iam_01_0008__row12993125812479"><td class="cellrowborder" valign="top" width="30.25%" headers="mcps1.3.10.2.1.3.1.1 "><p id="iam_01_0008__p8330313105918"><a href="iam_02_0043.html">Removing Specified Permissions of an Agency in All Projects</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.75%" headers="mcps1.3.10.2.1.3.1.2 "><p id="iam_01_0008__p16330121345915">Provided for the administrator to remove the specified permissions of an agency in all projects.</p>
</td>
</tr>
</tbody>
</table>
</div>
@ -528,7 +553,17 @@
</th>
</tr>
</thead>
<tbody><tr id="iam_01_0008__row122022331111"><td class="cellrowborder" valign="top" width="30.599999999999998%" headers="mcps1.3.11.2.1.3.1.1 "><p id="iam_01_0008__p1959131411539"><a href="iam_02_0024.html">Querying the Password Policy</a></p>
<tbody><tr id="iam_01_0008__row10605327918"><td class="cellrowborder" valign="top" width="30.599999999999998%" headers="mcps1.3.11.2.1.3.1.1 "><p id="iam_01_0008__p959614115316"><a href="iam_02_0022.html">Querying the Operation Protection Policy</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.39999999999999%" headers="mcps1.3.11.2.1.3.1.2 "><p id="iam_01_0008__p15991419537">Query the operation protection policy.</p>
</td>
</tr>
<tr id="iam_01_0008__row115901418531"><td class="cellrowborder" valign="top" width="30.599999999999998%" headers="mcps1.3.11.2.1.3.1.1 "><p id="iam_01_0008__p2059201417537"><a href="iam_02_0021.html">Modifying the Operation Protection Policy</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.39999999999999%" headers="mcps1.3.11.2.1.3.1.2 "><p id="iam_01_0008__p105901413531">Provided for the administrator to modify the operation protection policy.</p>
</td>
</tr>
<tr id="iam_01_0008__row122022331111"><td class="cellrowborder" valign="top" width="30.599999999999998%" headers="mcps1.3.11.2.1.3.1.1 "><p id="iam_01_0008__p1959131411539"><a href="iam_02_0024.html">Querying the Password Policy</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.39999999999999%" headers="mcps1.3.11.2.1.3.1.2 "><p id="iam_01_0008__p1859314185317">Query the password policy.</p>
</td>
@ -548,6 +583,26 @@
<td class="cellrowborder" valign="top" width="69.39999999999999%" headers="mcps1.3.11.2.1.3.1.2 "><p id="iam_01_0008__p85913142534">Provided for the administrator to modify the login authentication policy.</p>
</td>
</tr>
<tr id="iam_01_0008__row35114013111"><td class="cellrowborder" valign="top" width="30.599999999999998%" headers="mcps1.3.11.2.1.3.1.1 "><p id="iam_01_0008__p11912214155412"><a href="iam_02_0028.html">Querying the ACL for Console Access</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.39999999999999%" headers="mcps1.3.11.2.1.3.1.2 "><p id="iam_01_0008__p1391220142548">Query the ACL for console access.</p>
</td>
</tr>
<tr id="iam_01_0008__row1459814135315"><td class="cellrowborder" valign="top" width="30.599999999999998%" headers="mcps1.3.11.2.1.3.1.1 "><p id="iam_01_0008__p12598140536"><a href="iam_02_0027.html">Modifying the ACL for Console Access</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.39999999999999%" headers="mcps1.3.11.2.1.3.1.2 "><p id="iam_01_0008__p759131417533">Provided for the administrator to modify the ACL for console access.</p>
</td>
</tr>
<tr id="iam_01_0008__row1769517427111"><td class="cellrowborder" valign="top" width="30.599999999999998%" headers="mcps1.3.11.2.1.3.1.1 "><p id="iam_01_0008__p11912101412546"><a href="iam_02_0030.html">Querying the ACL for API Access</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.39999999999999%" headers="mcps1.3.11.2.1.3.1.2 "><p id="iam_01_0008__p267816554200">Query the ACL for API access.</p>
</td>
</tr>
<tr id="iam_01_0008__row359131455317"><td class="cellrowborder" valign="top" width="30.599999999999998%" headers="mcps1.3.11.2.1.3.1.1 "><p id="iam_01_0008__p19120142540"><a href="iam_02_0029.html">Modifying the ACL for API Access</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.39999999999999%" headers="mcps1.3.11.2.1.3.1.2 "><p id="iam_01_0008__p1791210148541">Provided for the administrator to modify the ACL for API access.</p>
</td>
</tr>
<tr id="iam_01_0008__row52312231772"><td class="cellrowborder" valign="top" width="30.599999999999998%" headers="mcps1.3.11.2.1.3.1.1 "><p id="iam_01_0008__p12483958676"><a href="iam_08_0012.html">Querying MFA Device Information of Users</a></p>
</td>
<td class="cellrowborder" valign="top" width="69.39999999999999%" headers="mcps1.3.11.2.1.3.1.2 "><p id="iam_01_0008__p12483458971">Provided for the administrator to query the MFA device information of users.</p>

190
docs/iam/api-ref/iam_02_0021.html
View File

File diff suppressed because it is too large Load Diff

2
docs/iam/api-ref/iam_02_0023.html
View File

@ -127,7 +127,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_02_0023__p11465103991913">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_02_0023__p14465439171911">Indicates whether the password can be the username or the username spelled backwards.</p>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_02_0023__p14465439171911">Whether the password can be the username or the username spelled backwards.</p>
</td>
</tr>
<tr id="iam_02_0023__row16465239111920"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_02_0023__p946523991916">password_validity_period</p>