yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
0b3a43371a4bcc99577594de0a685249d676a567
doc-exports/docs/iam/api-ref/iam_03_0006.html
weihongmin1 46d24ba358 IAM API 0401 Version 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: weihongmin1 <weihongmin1@huawei.com>
Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
2026-01-14 14:13:49 +00:00

1007 lines
79 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="iam_03_0006"></a><a name="iam_03_0006"></a>
<h1 class="topictitle1">Obtaining a User Token Through Password Authentication and Virtual MFA</h1>
<div id="body0000002518674115"><div class="section" id="iam_03_0006__en-us_topic_0221482385_section365913610201"><h4 class="sectiontitle">Function</h4><p id="iam_03_0006__en-us_topic_0221482385_p9660126162015">This API is used to obtain an IAM user token using the username, password, and virtual MFA device. To use this API, ensure that virtual MFA-based login protection has been enabled for the IAM user. A token is an access credential issued to a user to bear its identity and permissions. The token obtained using this API can be used to authenticate API calls to IAM and other cloud services.</p>
</div>
<div class="section" id="iam_03_0006__en-us_topic_0221482385_section20660262206"><h4 class="sectiontitle">URI</h4><p id="iam_03_0006__en-us_topic_0221482385_p2066114610207">POST /v3/auth/tokens</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_table166116614206" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Query parameters</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row26614618203"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p1966196192018">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.2.3.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p1166119662017"><strong id="iam_03_0006__b67938238465355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p16662661205">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.3.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p1666211612204">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row26618652012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p1666214616202">nocatalog</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p116627618205">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p146620672020">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p176621662202">If this parameter is set, no catalog information will be displayed in the response. Any non-empty string for this parameter will be interpreted as <strong id="iam_03_0006__b1877518101111">true</strong> and indicates that no catalog information will be displayed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_03_0006__en-us_topic_0221482385_section15662126152010"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row9663262206"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p1166317652010">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.059999999999999%" id="mcps1.3.3.2.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p56636620202"><strong id="iam_03_0006__b131952540565355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.939999999999998%" id="mcps1.3.3.2.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p1666317612011">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p666456102011">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row146631467202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p966410622011">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="10.059999999999999%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p16641063202">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.939999999999998%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p26648617206">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p1366412662013">Set this field to <strong id="iam_03_0006__b039154491112">application/json;charset=utf8</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_requestParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request body</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row66656652011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p156650610205">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.3.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p166656692013"><strong id="iam_03_0006__b142202321765355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p86669616204">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p14666563203">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row76654616209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p76667622010"><a href="#iam_03_0006__en-us_topic_0221482385_request_Rq3100Auth">auth</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1466612617202">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p466626202011">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p106667662015">Authentication information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_request_Rq3100Auth"></a><a name="en-us_topic_0221482385_request_Rq3100Auth"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_request_Rq3100Auth" frame="border" border="1" rules="all"><caption><b>Table 4 </b>auth</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row16667136142013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p136673632017">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.4.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p166685617201"><strong id="iam_03_0006__b82805960065355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p17668106142014">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.4.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p0668196112020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row76671162202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p12668164201"><a href="#iam_03_0006__en-us_topic_0221482385_request_Rq3100AuthIdentity">identity</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p966812642018">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p1668186132010">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p96681369202">Authentication parameters.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row1667176122016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p16691564204"><a href="#iam_03_0006__en-us_topic_0221482385_request_Rq31AuthScope">scope</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p206695615205">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p466910617206">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p2669666201">Application scope of the token. Value options: <strong id="iam_03_0006__b84059184665355">project</strong> and <strong id="iam_03_0006__b1533225365355">domain</strong>.</p>
<div class="note" id="iam_03_0006__en-us_topic_0221482385_note96691665204"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="iam_03_0006__ul5202151812299"><li id="iam_03_0006__li126881252131417"><strong id="iam_03_0006__b019019355911">If the scope is set to domain, the token applies to global services. If the scope is set to project, the token applies to project-level services.</strong></li><li id="iam_03_0006__li2465354191420"><strong id="iam_03_0006__b1619683514911">If the scope is set to both project and domain, the project is used and you get a token for project-level services.</strong></li><li id="iam_03_0006__li14177154619339"><strong id="iam_03_0006__b205754584665355">If the scope is left blank, you get a token for global services. You are advised to specify this parameter.</strong></li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_request_Rq3100AuthIdentity"></a><a name="en-us_topic_0221482385_request_Rq3100AuthIdentity"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_request_Rq3100AuthIdentity" frame="border" border="1" rules="all"><caption><b>Table 5 </b>auth.identity</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row13670266202"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p1267013662013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.5.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p1767086162013"><strong id="iam_03_0006__b142360137565355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p1767015615209">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.5.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p767015611204">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row1670116112012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p567115613208">methods</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.5.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p567120614202">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p267113662017">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p167114662013">Authentication method. </p>
<p id="iam_03_0006__en-us_topic_0221482385_p967186172017">The options are as follows:</p>
<ul id="iam_03_0006__en-us_topic_0221482385_ul1867110613208"><li id="iam_03_0006__en-us_topic_0221482385_li16719662010">password</li><li id="iam_03_0006__en-us_topic_0221482385_li12671562205">totp</li></ul>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row1667011682016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p86717632016"><a href="#iam_03_0006__en-us_topic_0221482385_request_Rq31AuthIdentityPwd">password</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.5.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p18672262207">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p467215692014">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.5.1.4 "><p id="iam_03_0006__p3982750145916">IAM user password authentication information.</p>
<div class="note" id="iam_03_0006__note15969195015919"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="iam_03_0006__p111742513218">Authentication information. Example:</p>
<pre class="screen" id="iam_03_0006__screen17174453211">"password": {
"user": {
"name": "<em id="iam_03_0006__i1917475520">user A</em>",
"password": "<em id="iam_03_0006__i131741251623">**********</em>",
"domain": {
"name": "<em id="iam_03_0006__i5174551522">domain A</em>"</pre>
<ul id="iam_03_0006__ul717414514214"><li id="iam_03_0006__li1917415517210"><strong id="iam_03_0006__b719216817311">user.name</strong>: Name of the user that wants to obtain the token. Obtain the username on the <strong id="iam_03_0006__b141933873119">My Credentials</strong> page.</li><li id="iam_03_0006__li21741951525"><strong id="iam_03_0006__b286484013111">password</strong>: Login password of the user.</li><li id="iam_03_0006__li13174125828"><strong id="iam_03_0006__b763304733110">domain.name</strong>: Name of the domain that created the user. Obtain the domain name on the <strong id="iam_03_0006__b16633124711317">My Credentials</strong> page.</li></ul>
</div></div>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row86702616200"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p767316615206"><a href="#iam_03_0006__en-us_topic_0221482385_request_Rq3100AuthIdentityTotp">totp</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.5.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p667396152015">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p116739613207">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p1567319612016"></p>
<p id="iam_03_0006__p6251471021">Authentication information. This parameter is mandatory only if you have enabled virtual MFA-based login protection.</p>
<p id="iam_03_0006__p122511471222">You can specify either <strong id="iam_03_0006__b16459813114412">user.id</strong> or <strong id="iam_03_0006__b945914134446">user.name</strong>.</p>
<div class="caution" id="iam_03_0006__note825447422"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><p id="iam_03_0006__p7256471212"></p>
</div></div>
<p id="iam_03_0006__p172524719215">Example 1:</p>
<pre class="screen" id="iam_03_0006__screen1825247628">"totp": {
"user": {
"id": "b95b78b67fa045b38104c12fb...",
"passcode": "******"</pre>
<ul id="iam_03_0006__ul126144716220"><li id="iam_03_0006__li1326164712213"><strong id="iam_03_0006__b20113194514">user.id</strong>: User ID, which can be obtained on the <strong id="iam_03_0006__b10171310453">My Credentials</strong> page.</li><li id="iam_03_0006__li132618473217"><strong id="iam_03_0006__b1227016192457">passcode</strong>: MFA verification code, which can be obtained on the MFA App.</li></ul>
<p id="iam_03_0006__p226447829">Example 2:</p>
<pre class="screen" id="iam_03_0006__screen152644718218">"totp": {
"user": {
"name": "user A",
"passcode": "******"</pre>
<ul id="iam_03_0006__ul226647720"><li id="iam_03_0006__li3262471022"><strong id="iam_03_0006__b12272026144516">user.name</strong>: Name of the user that wants to obtain the token.</li><li id="iam_03_0006__li1526147224"><strong id="iam_03_0006__b8714112454512">passcode</strong>: MFA verification code, which can be obtained on the MFA App.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthIdentityPwd"></a><a name="en-us_topic_0221482385_request_Rq31AuthIdentityPwd"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthIdentityPwd" frame="border" border="1" rules="all"><caption><b>Table 6 </b>auth.identity.password</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row367346132019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p46746619209">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.6.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p12674564207"><strong id="iam_03_0006__b45683974565355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p26741366206">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.6.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p17674966206">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row156732611208"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p8674365200"><a href="#iam_03_0006__en-us_topic_0221482385_request_Rq31AuthIdentityPwdUser">user</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.6.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p0674206192014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p12675462207">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.6.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p146753619204">Information about the IAM user who is requesting to obtain a token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthIdentityPwdUser"></a><a name="en-us_topic_0221482385_request_Rq31AuthIdentityPwdUser"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthIdentityPwdUser" frame="border" border="1" rules="all"><caption><b>Table 7 </b>auth.identity.password.user</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row1667506172018"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p166764618201">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.7.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p767618611209"><strong id="iam_03_0006__b84040794065355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p46767652010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.7.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p14676186172014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row1467510662013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p16676963204"><a href="#iam_03_0006__en-us_topic_0221482385_request_Rq31AuthIdentityPwdUserDomain">domain</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.7.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p7676116122014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p267617620207">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.7.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p167715611205">Information about the account used to create the IAM user.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row967514672017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p20677186132013">name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.7.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p9677126162016">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p116770672020">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.7.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p7677268202">IAM username.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row367514612016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p156777622013">password</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.7.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p567714652017">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p2067810618208">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.7.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p8678196152010">Password of the IAM user.</p>
<div class="note" id="iam_03_0006__note1890710512544"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="iam_03_0006__ul817215473474"><li id="iam_03_0006__li3172154764719">To obtain a token successfully, ensure that the password you provide is correct.</li><li id="iam_03_0006__li161721047194719">A third-party system user cannot directly obtain a token by using the username and password used for identity federation. Go to the cloud platform login page, click <strong id="iam_03_0006__b48557476467">Forgot Password</strong>, and reset the password.</li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthIdentityPwdUserDomain"></a><a name="en-us_topic_0221482385_request_Rq31AuthIdentityPwdUserDomain"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthIdentityPwdUserDomain" frame="border" border="1" rules="all"><caption><b>Table 8 </b>auth.identity.password.user.domain</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row126781682012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p206785622015">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.8.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p9678468207"><strong id="iam_03_0006__b104467366565355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p1367917619203">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.8.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p16792632016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row1767815611202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p6679564208">name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.8.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p9679365207">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p1968086182013">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.8.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p7680363205">Name of the account used to create the IAM user.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_request_Rq3100AuthIdentityTotp"></a><a name="en-us_topic_0221482385_request_Rq3100AuthIdentityTotp"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_request_Rq3100AuthIdentityTotp" frame="border" border="1" rules="all"><caption><b>Table 9 </b>auth.identity.totp</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row16801264205"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.9.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p156812612018">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.9.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p1268196192012"><strong id="iam_03_0006__b16747344865355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.9.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p26811564205">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.9.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p168120672016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row7680962206"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p2068113642018"><a href="#iam_03_0006__en-us_topic_0221482385_request_Rq3100AuthIdentityTotpUser">user</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.9.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p46815615203">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p368119619205">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.9.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p66821267209">IAM user information. Login protection has been enabled for the IAM user, and a virtual MFA device is used for identity authentication.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_request_Rq3100AuthIdentityTotpUser"></a><a name="en-us_topic_0221482385_request_Rq3100AuthIdentityTotpUser"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_request_Rq3100AuthIdentityTotpUser" frame="border" border="1" rules="all"><caption><b>Table 10 </b>auth.identity.totp.user</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row1868215611201"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.10.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p19682186182013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.10.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p1168296122018"><strong id="iam_03_0006__b173670748665355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.10.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p14683186192015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.10.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p76831614208">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row96821664203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p56839614207">id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.10.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p186831263205">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p6683126152013">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.10.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p06832611207">ID of the IAM user for whom virtual MFA-based login protection has been enabled.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row368216682013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p368313612010">passcode</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.10.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p156847619206">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p1268417682016">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.10.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_p206841165200">MFA verification code, which can be obtained on the MFA App.</p>
<div class="note" id="iam_03_0006__note4971125905415"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="iam_03_0006__p208369095519">To obtain a token successfully, ensure that the verification code you provide is correct.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthScope"></a><a name="en-us_topic_0221482385_request_Rq31AuthScope"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthScope" frame="border" border="1" rules="all"><caption><b>Table 11 </b>auth.scope</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row19684865209"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.11.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p36859619202">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.11.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p16685116182012"><strong id="iam_03_0006__b10673776765355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.11.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p14685663202">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.11.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p1768536182014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row46844652017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p76852672010"><a href="#iam_03_0006__en-us_topic_0221482385_request_Rq31AuthScopeDomain">domain</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.11.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p968546172010">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p1268666142012">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.11.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482476_p193963531941">If this parameter is set to <strong id="iam_03_0006__b163130651165355">domain</strong>, the token can be used to access global services, such as OBS. Global services are not subject to any projects or regions. You can specify either <strong id="iam_03_0006__b194129136665355">id</strong> or <strong id="iam_03_0006__b113018087865355">name</strong>. <strong id="iam_03_0006__b77028695665355">domain.id</strong> is recommended.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row1568426172012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p176868614205"><a href="#iam_03_0006__en-us_topic_0221482385_request_Rq31AuthScopeProject">project</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.11.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1368646152011">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p96861616202">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.11.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482476_p13979534417">If this parameter is set to <strong id="iam_03_0006__b81000946465355">project</strong>, the token can be used to access only services (such as ECS) in specific projects. You can specify either <strong id="iam_03_0006__b214076296665355">id</strong> or <strong id="iam_03_0006__b36803718465355">name</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthScopeDomain"></a><a name="en-us_topic_0221482385_request_Rq31AuthScopeDomain"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthScopeDomain" frame="border" border="1" rules="all"><caption><b>Table 12 </b>auth.scope.domain</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row1568656142010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.12.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p1668715602013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.12.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p268716632011"><strong id="iam_03_0006__b191825218665355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.12.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p0687464208">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.12.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p1868715610208">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row66870618201"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p16688196112019">id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.12.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p468826142012">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p368815615209">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.12.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_en-us_topic_0221460195_p46112337149">ID of the account used to create the IAM user.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row12687156122010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p868826102015">name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.12.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p116881468206">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p17689156162015">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.12.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_en-us_topic_0221460195_p36121733121417">Name of the account used to create the IAM user.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthScopeProject"></a><a name="en-us_topic_0221482385_request_Rq31AuthScopeProject"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_request_Rq31AuthScopeProject" frame="border" border="1" rules="all"><caption><b>Table 13 </b>auth.scope.project</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row166899692017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.13.2.5.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p1768910642019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.13.2.5.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p56909613209"><strong id="iam_03_0006__b22748641565355">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.13.2.5.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p1669076152015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.13.2.5.1.4"><p id="iam_03_0006__en-us_topic_0221482385_p6690669208">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row1368918652019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p13690961209">id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.13.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p136901468204">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p12690186192016">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.13.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_en-us_topic_0221460195_p86161233151410">ID of the project to which the IAM user belongs.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row1368946112020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p669114613203">name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.13.2.5.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p66914622012">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p06911461200">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.13.2.5.1.4 "><p id="iam_03_0006__en-us_topic_0221482385_en-us_topic_0221460195_p761723312149">Project name of the account used to create the IAM user.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_03_0006__en-us_topic_0221482385_section1087706192012"><h4 class="sectiontitle">Example Request</h4><ul id="iam_03_0006__ul1293684312518"><li id="iam_03_0006__en-us_topic_0026585112_li17042198">Sample request<p id="iam_03_0006__a8fbaf401ac2d466888905fc593f3fc49"><a name="iam_03_0006__en-us_topic_0026585112_li17042198"></a><a name="en-us_topic_0026585112_li17042198"></a>The following is a sample request for obtaining a token for <strong id="iam_03_0006__b19115184354816">user A</strong>. The login password of the user is <strong id="iam_03_0006__b211544319485">**********</strong> and the domain name is <strong id="iam_03_0006__b1115184311480">domain A</strong>. The scope of the token is <strong id="iam_03_0006__b10115194312482">domain</strong>.</p>
<pre class="screen" id="iam_03_0006__screen165731206134">{
"auth": {
"identity": {
"methods": ["password"],
"password": {
"user": {
"name": "user A",
"password": "**********",
"domain": {
"name": "domain A"
}
}
}
},
"scope": {
"domain": {
"name": "domain A"
}
}
}
}</pre>
<p id="iam_03_0006__p13668471681">The following is a sample request for obtaining a token when virtual MFA–based login authentication is enabled.</p>
<pre class="screen" id="iam_03_0006__screen8267533164417">{
"auth": {
"identity": {
"methods": ["password", "totp"],
"password": {
"user": {
"name": "user A",
"password": "********",
"domain": {
"name": "domain A"
}
}
},
"totp" : {
"user": {
"name": "user A",
"passcode": "******"
}
}
},
"scope": {
"domain": {
"name": "domain A"
}
}
}
}</pre>
</li></ul>
</div>
<div class="section" id="iam_03_0006__en-us_topic_0221482385_section136919632018"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_ResponseHeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 14 </b>Parameters in the response header</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row13692166172014"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.2.2.4.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p4692168201">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.2.4.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p1069215682014">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.2.4.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p1969215652011">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row66921163208"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p169214612013">X-Subject-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1469314610200">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p12693146202011">Signed token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_responseParameter" frame="border" border="1" rules="all"><caption><b>Table 15 </b>Parameters in the response body</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row106938672012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p669386182010">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p386976162011">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p158691263201">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row146931692017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p586918612015"><a href="#iam_03_0006__en-us_topic_0221482385_response_Rs31Token">token</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1486912614201">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p188695682017">Token information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_response_Rs31Token"></a><a name="en-us_topic_0221482385_response_Rs31Token"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_response_Rs31Token" frame="border" border="1" rules="all"><caption><b>Table 16 </b>token</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row2069516602010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p2870146152018">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p1870156142010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p3870763204">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row06955611209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p18870366207"><a href="#iam_03_0006__en-us_topic_0221482385_response_Rs31TokenCatalogArritem">catalog</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1287018682010">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p7870367208">Endpoint information.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row126959615208"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p7870156142019"><a href="#iam_03_0006__en-us_topic_0221482385_response_Rs31TokenDomain">domain</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p98701610205">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p1870206192016">Account information about the IAM user who requests for the token. This parameter is returned only when the <strong id="iam_03_0006__b159416808965355">scope</strong> parameter in the request body has been set to <strong id="iam_03_0006__b194459289465355">domain</strong>.</p>
</td>
</tr>
<tr id="iam_03_0006__row14995718175618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="iam_03_0006__p17996318195616">expires_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="iam_03_0006__p599671815612">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="iam_03_0006__p1099615183560">Expiration date of the token.</p>
</td>
</tr>
<tr id="iam_03_0006__row6581184625616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="iam_03_0006__p4581046145616">issued_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="iam_03_0006__p958164695617">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="iam_03_0006__p10581174617564">Time when the token was issued.</p>
</td>
</tr>
<tr id="iam_03_0006__row15805152614116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="iam_03_0006__p380513263410">mfa_authn_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="iam_03_0006__p380542654117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="iam_03_0006__p48058264417">MFA authentication time. This field is displayed only when virtual MFA–based login authentication is enabled.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row46955642015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p98701614209">methods</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p12870156142016">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p4870768204">Method for obtaining the token.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row156955612017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p10870169201"><a href="#iam_03_0006__en-us_topic_0221482385_response_Rs31TokenProject">project</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p16870106152014">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p987017612202">Project information about the IAM user who requests for the token. This parameter is returned only when the <strong id="iam_03_0006__b210584679265355">scope</strong> parameter in the request body has been set to <strong id="iam_03_0006__b64944408265355">project</strong>.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row196951064201"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p118708619202"><a href="#iam_03_0006__en-us_topic_0221482385_response_Rs31TokenRolesArritem">roles</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p58700617209">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p487016610202">Permissions information of the token.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row369556132010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p10870186172010"><a href="#iam_03_0006__en-us_topic_0221482385_response_Rs31TokenUser">user</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p787019613208">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p128701865203">Information about the IAM user who requests for the token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenCatalogArritem"></a><a name="en-us_topic_0221482385_response_Rs31TokenCatalogArritem"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenCatalogArritem" frame="border" border="1" rules="all"><caption><b>Table 17 </b>token.catalog</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row2069846202011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p28711660208">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p7871562200">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p9871265203">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row14698663201"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p58711632012"><a href="#iam_03_0006__en-us_topic_0221482385_response_Rs31TokenCatalogArritemEndpointsArritem">endpoints</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p4871166182013">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p4871126112020">Endpoint information.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row136981460203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p1787118622017">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p16871764202">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p387518615203">Service ID.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row166981567202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p287510618200">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p128751615208">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p8875368203">Service name.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row9698160207"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p0875146112012">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p687610652016">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p98761261203">Type of the service to which the API belongs.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenCatalogArritemEndpointsArritem"></a><a name="en-us_topic_0221482385_response_Rs31TokenCatalogArritemEndpointsArritem"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenCatalogArritemEndpointsArritem" frame="border" border="1" rules="all"><caption><b>Table 18 </b>token.catalog.endpoints</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row270116672015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p208768692016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p188761667206">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p38761682015">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row270111642017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p168768613208">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1687606162014">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p16876262204">Endpoint ID.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row127010672013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p5876767205">interface</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p14876166162011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p17876186122010">Visibility of the API. <strong id="iam_03_0006__b175223264765355">public</strong> indicates that the API is available for public access.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row1670115612202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p6876667205">region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1887619692014">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p1787620618207">Region to which the endpoint belongs.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row147018642014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p208767662015">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p16876869203">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p187696152013">Region ID.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row127018617207"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p68761569200">url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p18876268202">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p1287616616205">Endpoint URL.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenDomain"></a><a name="en-us_topic_0221482385_response_Rs31TokenDomain"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenDomain" frame="border" border="1" rules="all"><caption><b>Table 19 </b>token.domain</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row57031264206"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p18762065201">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p18761365204">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p198765682016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row1870316122016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p11876763207">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p68760652018">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p128761161201">Domain name.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row570318620201"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p0876116152015">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p188763613204">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p987613642019">Domain ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenProject"></a><a name="en-us_topic_0221482385_response_Rs31TokenProject"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenProject" frame="border" border="1" rules="all"><caption><b>Table 20 </b>token.project</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row127056615205"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p38760682016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.8.2.4.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p48765615208">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.8.2.4.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p687618617208">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row1670514612203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p198766613203"><a href="#iam_03_0006__en-us_topic_0221482385_response_Rs31TokenProjectDomain">domain</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1187656122012">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p087616617208">Domain information of the project.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row1170513682017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p08767662010">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p178761360202">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p14876867201">Project ID.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row97051561202"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p208761612204">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.8.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p15876163203">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.8.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p1287614613203">Project name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenProjectDomain"></a><a name="en-us_topic_0221482385_response_Rs31TokenProjectDomain"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenProjectDomain" frame="border" border="1" rules="all"><caption><b>Table 21 </b>token.project.domain</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row147076619207"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p48777617204">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p8877168203">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p98772063201">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row197071160204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p198772632013">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1187766132014">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p787719617207">Domain ID.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row147075632019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p168772622016">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1587710620201">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p1987746152019">Domain name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenRolesArritem"></a><a name="en-us_topic_0221482385_response_Rs31TokenRolesArritem"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenRolesArritem" frame="border" border="1" rules="all"><caption><b>Table 22 </b>token.roles</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row77081632015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p12877116172018">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.10.2.4.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p187719615206">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.10.2.4.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p38771766209">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row137081768207"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p48776614209">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p3877369204">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p168776613207">Permission name.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row070856152010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p68773619201">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.10.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p20877106172015">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.10.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p3877166132015">Permission ID. The default value is <strong id="iam_03_0006__b107954189165355">0</strong>, which does not correspond to any permission.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenUser"></a><a name="en-us_topic_0221482385_response_Rs31TokenUser"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenUser" frame="border" border="1" rules="all"><caption><b>Table 23 </b>token.user</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row147110612201"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p168777662011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p287710692014">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p158775618205">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row177119618208"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p168771566205">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p887716192018">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p387796122018">IAM username.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row1971119672018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p17877460208">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p387716612013">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p1787711652012">IAM user ID.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row3711196182017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p7877116142017">password_expires_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1687713616207">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p18877136142014">Password expiration time. If this parameter is not specified, the password will never expire.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row5711116132012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p9877461208"><a href="#iam_03_0006__en-us_topic_0221482385_response_Rs31TokenUserDomain">domain</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p15877186122014">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p1087796182014">Information about the account used to create the IAM user.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenUserDomain"></a><a name="en-us_topic_0221482385_response_Rs31TokenUserDomain"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_response_Rs31TokenUserDomain" frame="border" border="1" rules="all"><caption><b>Table 24 </b>token.user.domain</caption><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row571416622010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p20877136182010">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.12.2.4.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p19877762201">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.12.2.4.1.3"><p id="iam_03_0006__en-us_topic_0221482385_p38776616204">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row371412611204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p18776619205">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1487710642012">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p68771462207">Name of the account used to create the IAM user.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row47146611200"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p1387736142011">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.12.2.4.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p58774617207">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.12.2.4.1.3 "><p id="iam_03_0006__en-us_topic_0221482385_p38771066207">ID of the account used to create the IAM user.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_03_0006__en-us_topic_0221482385_section198786612202"><h4 class="sectiontitle">Example Response</h4><ul id="iam_03_0006__ul16292855162710"><li id="iam_03_0006__lf3c28402a2ee4844bc99946ea67bf82d">Example response<div class="p" id="iam_03_0006__p01640289481"><a name="iam_03_0006__lf3c28402a2ee4844bc99946ea67bf82d"></a><a name="lf3c28402a2ee4844bc99946ea67bf82d"></a>The following is a sample request for obtaining a token for <strong id="iam_03_0006__b999455414817">user A</strong>. The login password of the user is <strong id="iam_03_0006__b1994165414820">**********</strong> and the domain name is <strong id="iam_03_0006__b1299405419486">domain A</strong>. The scope of the token is <strong id="iam_03_0006__b129945544481">domain</strong>.<pre class="screen" id="iam_03_0006__screen0241121164815">Token information stored in the response header:
X-Subject-Token:MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
Token information stored in the response body:
{
"token" : {
"methods" : ["password"],
"expires_at" : "2015-11-09T01:42:57.527363Z",
"issued_at" : "2015-11-09T00:42:57.527404Z",
"user" : {
"domain" : {
"id" : "ded485def148s4e7d2se41d5se...",
"name" : "domain A"
},
"id" : "ee4dfb6e5540447cb37419051...",
"name" : "user A",
"password_expires_at":"2016-11-06T15:32:17.000000",
},
"domain" : {
"name" : "domain A",
"id" : "dod4ed5e8d4e8d2e8e8d5d2d..."
},
"catalog": [{
"type": "identity",
"id": "1331e5cff2a74d76b03da12259...",
"name": "iam",
"endpoints": [{
"url": "<em id="iam_03_0006__i10340154237">https://sample.domain.com</em>/v3",
"region": "*",
"region_id": "*",
"interface": "public",
"id": "089d4a381d574308a703122d3a..."
}]
}],
"roles" : [{
"name" : "role1",
"id" : "roleid1"
}, {
"name" : "role2",
"id" : "roleid2"
}
]
}
}</pre>
</div>
<p id="iam_03_0006__p12906728497">The following is a sample request for obtaining a token when virtual MFA–based login authentication is enabled.</p>
<pre class="screen" id="iam_03_0006__screen2910740175712">Token information stored in the response header:
X-Subject-Token:MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...
Token information stored in the response body:
{
"token": {
"expires_at": "2020-09-05T06:50:44.390000Z",
"mfa_authn_at": "2020-09-04T06:50:44.390000Z",
"issued_at": "2020-09-04T06:50:44.390000Z",
"methods": [
"password",
"totp"
],
"catalog": [
{
"endpoints": [
{
"id": "33e1cbdd86d34e89a63cf8ad16a5f...",
"interface": "public",
"region": "*",
"region_id": "*",
"url": "<em id="iam_03_0006__i15950841634">https://sample.domain.com</em>/v3.0"
}
],
"id": "100a6a3477f1495286579b819d399...",
"name": "iam",
"type": "iam"
},
],
"domain": {
"id": "e6505630658e49649784759cdf251...",
"name": "domain A"
},
"roles": [
{
"name" : "role1",
"id" : "roleid1"
},{
"name" : "role1",
"id" : "roleid1"
}
],
"user": {
"domain": {
"id": "e6505630658e49649784759cdf251...",
"name": "domain A"
},
"id": "092ac6365a0025b11f76c01e90100...",
"name": "user A",
"password_expires_at": ""
}
}
}</pre>
</li></ul>
</div>
<div class="section" id="iam_03_0006__en-us_topic_0221482385_section588112611208"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_03_0006__en-us_topic_0221482385_table2418" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_03_0006__en-us_topic_0221482385_row0727126102015"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="iam_03_0006__en-us_topic_0221482385_p13881867200">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="iam_03_0006__en-us_topic_0221482385_p208815622016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_03_0006__en-us_topic_0221482385_row1872706122010"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p19881165204">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p11881166192018">Creation succeeded.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row1472786122017"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p98811566207">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p488115616207">Invalid parameters.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row1372711692020"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p188818620208">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p1288112682010">Authentication failed.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row87271265202"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p11881156122013">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p158819682014">Access denied.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row372756182015"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p138818692010">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p148812622020">Requested resource cannot found.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row87278613208"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p18811466201">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p148811617201">Internal server error.</p>
</td>
</tr>
<tr id="iam_03_0006__en-us_topic_0221482385_row472786102018"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_03_0006__en-us_topic_0221482385_p1888112662014">503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_03_0006__en-us_topic_0221482385_p14881176102013">Service unavailable.</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>
View Git Blame Copy Permalink