forked from docs/doc-exports
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: weihongmin1 <weihongmin1@huawei.com> Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
891 lines
70 KiB
HTML
891 lines
70 KiB
HTML
<a name="en-us_topic_0057845583"></a><a name="en-us_topic_0057845583"></a>
|
||
|
||
<h1 class="topictitle1">Obtaining a User Token Through Password Authentication</h1>
|
||
<div id="body1559206849798"><div class="section" id="en-us_topic_0057845583__s5888597838b0425a92e3419fb766c7f5"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845583__p1691133013483">This API is used to obtain a token through username/password authentication. A token is a system object encapsulating the identity and permissions of a user. When calling the APIs of IAM or other cloud services, you can use this API to obtain a token for authentication.</p>
|
||
<div class="note" id="en-us_topic_0057845583__note6480102712573"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="en-us_topic_0057845583__ul16340103982210"><li id="en-us_topic_0057845583__li63400391221">The validity period of a token is <strong id="en-us_topic_0057845583__b209678010379">24 hours</strong>. Cache your token to prevent frequent API calling. Ensure that the token is valid while you use it. Using a token that will soon expire may cause API calling failures. Obtaining a new token does not affect the validity of the existing token.</li><li id="en-us_topic_0057845583__li1758917479222"><strong id="en-us_topic_0057845583__b274605132012">The token or the tokens of the account will become invalid within 30 minutes</strong> if any of the following occurs:<ul id="en-us_topic_0057845583__ul41081317193610"><li id="en-us_topic_0057845583__li8109117193616">An IAM user is deleted or disabled.</li><li id="en-us_topic_0057845583__li2996924153614">An IAM user's password or access key is changed.</li><li id="en-us_topic_0057845583__li320017408364">An IAM user's permissions are changed (due to outstanding payments, OBT application approval, or permission modification). Your account is in arrears, you apply for or exit the OBT, or the permissions of any user group under your account are changed.</li></ul>
|
||
</li></ul>
|
||
<ul id="en-us_topic_0057845583__ul681995142214"><li id="en-us_topic_0057845583__li681975192218">If "The token must be updated" is returned when a token is used to call a cloud service API, the token has expired or is invalid. You need to obtain a new token.</li><li id="en-us_topic_0057845583__li1670011544224">A token will fail to pass the signature verification if it has been tampered with.</li></ul>
|
||
</div></div>
|
||
</div>
|
||
<div class="section" id="en-us_topic_0057845583__s46d3616bd4c54e55ba97a528518a5890"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0057845583__a80e962a80e7749d3b159c2c7380021bf">POST /v3/auth/tokens</p>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__en-us_topic_0221482385_table166116614206" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Query parameters</caption><thead align="left"><tr id="en-us_topic_0057845583__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="en-us_topic_0057845583__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="en-us_topic_0057845583__en-us_topic_0221482385_p1166119662017">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="en-us_topic_0057845583__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="en-us_topic_0057845583__en-us_topic_0221482385_p1666211612204">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__en-us_topic_0221482385_row26618652012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-us_topic_0057845583__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="en-us_topic_0057845583__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="en-us_topic_0057845583__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="en-us_topic_0057845583__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="en-us_topic_0057845583__b1995812465270">true</strong> and no catalog information will be displayed.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="en-us_topic_0057845583__se7fe5cac0d544e119c49322cc1707eb6"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845583__en-us_topic_0026585112_ul3226198"><li id="en-us_topic_0057845583__l7c4919f55ea849a9bb59e1454113085c">Parameters in the request header
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__t68c7bd10e66a4380a1e6cdc78ca95669" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__r584496594a404ce18918a40e6e57c2ec"><th align="left" class="cellrowborder" valign="top" width="17.818218178182182%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845583__ac3a989cc5d3a405889eabb47dee84b04">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="17.568243175682433%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845583__a69a20ac00b86496aa8418517c542b0da">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="18.108189181081894%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845583__a92c23d4441054df0972e025aeb3a8d7f">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="46.5053494650535%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845583__abe6882c44cf4402d8ed7706b9278f33b">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__r5d63069d6a8a426e8b25b94d1b4d302a"><td class="cellrowborder" valign="top" width="17.818218178182182%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845583__ad4fb6253385c46ab8720a0e13f573694">Content-Type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.568243175682433%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845583__a6b33800bcb2a446695b1d33a2d751554">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.108189181081894%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845583__ab34a5e95b76b4b79a72da0734025f211">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="46.5053494650535%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845583__a716277ae541d4553bb10490f9c02593d">Fill <span class="parmvalue" id="en-us_topic_0057845583__parmvalue17621591774"><b>application/json;charset=utf8</b></span> in this field.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="en-us_topic_0057845583__li29686715597">Parameters in the request body
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table73767545584" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__row16391954135811"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.1.1.5.1.1"><p id="en-us_topic_0057845583__p1039115475810">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.1.1.5.1.2"><p id="en-us_topic_0057845583__p139116547587">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.1.1.5.1.3"><p id="en-us_topic_0057845583__p1391105419583">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.1.1.5.1.4"><p id="en-us_topic_0057845583__p12391154125816">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row153912541584"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845583__p1339195415584"><a href="#en-us_topic_0057845583__li9161113917599">auth</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845583__p03918543587">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845583__p113911754135820">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845583__p18391454175818">Authentication information.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="en-us_topic_0057845583__li9161113917599"><a name="en-us_topic_0057845583__li9161113917599"></a><a name="li9161113917599"></a>auth
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table138769191593" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__row1389016191598"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.3.1.1.5.1.1"><p id="en-us_topic_0057845583__p148904196596">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.3.1.1.5.1.2"><p id="en-us_topic_0057845583__p98901519135912">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.3.1.1.5.1.3"><p id="en-us_topic_0057845583__p17890101920592">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.3.1.1.5.1.4"><p id="en-us_topic_0057845583__p68901819165914">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row8890161913599"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.1.5.1.1 "><p id="en-us_topic_0057845583__p089051985918"><a href="#en-us_topic_0057845583__li521911596593">identity</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.3.1.1.5.1.2 "><p id="en-us_topic_0057845583__p1689018192593">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.1.5.1.3 "><p id="en-us_topic_0057845583__p15890219115918">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.3.1.1.5.1.4 "><p id="en-us_topic_0057845583__p789031915593">Authentication parameters.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row11890191955913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.1.5.1.1 "><p id="en-us_topic_0057845583__p589071995911"><a href="#en-us_topic_0057845583__li152529541647">scope</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.3.1.1.5.1.2 "><p id="en-us_topic_0057845583__p188906197590">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.1.5.1.3 "><p id="en-us_topic_0057845583__p12890121910590">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.3.1.1.5.1.4 "><p id="en-us_topic_0057845583__p14890919115911">Application scope of the token. Value options: <strong id="en-us_topic_0057845583__b14225183553212">project</strong> and <strong id="en-us_topic_0057845583__b1222510353323">domain</strong>.</p>
|
||
<div class="note" id="en-us_topic_0057845583__note2877141918599"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="en-us_topic_0057845583__ul1989091925917"><li id="en-us_topic_0057845583__li158902198599">If the scope is set to <strong id="en-us_topic_0057845583__b162384910328">domain</strong>, the token applies to global services. If the scope is set to <strong id="en-us_topic_0057845583__b3623144915328">project</strong>, the token applies to project-level services.</li><li id="en-us_topic_0057845583__li689041995910">If you set the scope to both <strong id="en-us_topic_0057845583__b64401313133319">project</strong> and <strong id="en-us_topic_0057845583__b14441413183319">domain</strong>, the <strong id="en-us_topic_0057845583__b13441161311330">project</strong> is used and you get a token for project-level services.</li><li id="en-us_topic_0057845583__li138901419135916">If you leave <strong id="en-us_topic_0057845583__b45691355363">scope</strong> empty, the token applies to global services. You are advised to specify an appropriate scope as required.</li></ul>
|
||
</div></div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="en-us_topic_0057845583__li521911596593"><a name="en-us_topic_0057845583__li521911596593"></a><a name="li521911596593"></a>auth.identity
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table1596720505590" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__row69821550115918"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.4.1.1.5.1.1"><p id="en-us_topic_0057845583__p1798213508597">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.4.1.1.5.1.2"><p id="en-us_topic_0057845583__p698235018595">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.4.1.1.5.1.3"><p id="en-us_topic_0057845583__p698216509599">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.4.1.1.5.1.4"><p id="en-us_topic_0057845583__p11982950135911">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row6982850115918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.4.1.1.5.1.1 "><p id="en-us_topic_0057845583__p1398218505591">methods</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.4.1.1.5.1.2 "><p id="en-us_topic_0057845583__p109821550195919">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.4.1.1.5.1.3 "><p id="en-us_topic_0057845583__p1098215011590">Array of strings</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.4.1.1.5.1.4 "><p id="en-us_topic_0057845583__p1798213501598">Authentication method. Set this parameter to <strong id="en-us_topic_0057845583__b1244961514296">"password"</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row1198265065912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.4.1.1.5.1.1 "><p id="en-us_topic_0057845583__p10982450165916"><a href="#en-us_topic_0057845583__li2030154913010">password</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.4.1.1.5.1.2 "><p id="en-us_topic_0057845583__p898211502591">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.4.1.1.5.1.3 "><p id="en-us_topic_0057845583__p19982135019590">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.4.1.1.5.1.4 "><p id="en-us_topic_0057845583__p3982750145916">IAM user password authentication information.</p>
|
||
<div class="note" id="en-us_topic_0057845583__note15969195015919"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0057845583__p111742513218">Authentication information. Example:</p>
|
||
<pre class="screen" id="en-us_topic_0057845583__screen17174453211">"password": {
|
||
"user": {
|
||
"name": "<em id="en-us_topic_0057845583__i1917475520">user A</em>",
|
||
"password": "<em id="en-us_topic_0057845583__i131741251623">**********</em>",
|
||
"domain": {
|
||
"name": "<em id="en-us_topic_0057845583__i5174551522">domain A</em>"</pre>
|
||
<ul id="en-us_topic_0057845583__ul717414514214"><li id="en-us_topic_0057845583__li1917415517210"><strong id="en-us_topic_0057845583__b1749944084213">user.name</strong>: Name of the user that wants to obtain the token. Obtain the username on the <strong id="en-us_topic_0057845583__b0207101810433">My Credentials</strong> page.</li><li id="en-us_topic_0057845583__li21741951525"><strong id="en-us_topic_0057845583__b181311636194319">password</strong>: Login password of the user.</li><li id="en-us_topic_0057845583__li13174125828"><strong id="en-us_topic_0057845583__b15949115334320">domain.name</strong>: Name of the domain that created the user. Obtain the domain name on the <strong id="en-us_topic_0057845583__b87551617445">My Credentials</strong> page.</li></ul>
|
||
</div></div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="en-us_topic_0057845583__li2030154913010"><a name="en-us_topic_0057845583__li2030154913010"></a><a name="li2030154913010"></a>auth.identity.password
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table1850216405017" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__row1351310401020"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.5.1.1.5.1.1"><p id="en-us_topic_0057845583__p4513840501">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.5.1.1.5.1.2"><p id="en-us_topic_0057845583__p1251314401603">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.5.1.1.5.1.3"><p id="en-us_topic_0057845583__p1651310403016">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.5.1.1.5.1.4"><p id="en-us_topic_0057845583__p0513940007">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row95131140703"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.5.1.1.5.1.1 "><p id="en-us_topic_0057845583__p11513440902"><a href="#en-us_topic_0057845583__li93251722349">user</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.5.1.1.5.1.2 "><p id="en-us_topic_0057845583__p25135407010">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.5.1.1.5.1.3 "><p id="en-us_topic_0057845583__p1851319404015">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.5.1.1.5.1.4 "><p id="en-us_topic_0057845583__p145131040600">Information about the IAM user who is requesting to obtain a token.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="en-us_topic_0057845583__li93251722349"><a name="en-us_topic_0057845583__li93251722349"></a><a name="li93251722349"></a>auth.identity.password.user
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table7782171416111" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__row08135147110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.6.1.1.5.1.1"><p id="en-us_topic_0057845583__p208131114611">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.6.1.1.5.1.2"><p id="en-us_topic_0057845583__p1081321419118">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.6.1.1.5.1.3"><p id="en-us_topic_0057845583__p18813111418111">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.6.1.1.5.1.4"><p id="en-us_topic_0057845583__p781314141315">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row581318147110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.6.1.1.5.1.1 "><p id="en-us_topic_0057845583__p881311142119"><a href="#en-us_topic_0057845583__li19469631442">domain</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.6.1.1.5.1.2 "><p id="en-us_topic_0057845583__p88130141118">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.6.1.1.5.1.3 "><p id="en-us_topic_0057845583__p18133141215">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.6.1.1.5.1.4 "><p id="en-us_topic_0057845583__p10813181411120">Information about the account used to create the IAM user.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row581315140114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.6.1.1.5.1.1 "><p id="en-us_topic_0057845583__p178139141710">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.6.1.1.5.1.2 "><p id="en-us_topic_0057845583__p5813914913">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.6.1.1.5.1.3 "><p id="en-us_topic_0057845583__p58135146119">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.6.1.1.5.1.4 "><p id="en-us_topic_0057845583__p581314142114">IAM username</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row88131314318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.6.1.1.5.1.1 "><p id="en-us_topic_0057845583__p158137146110">password</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.6.1.1.5.1.2 "><p id="en-us_topic_0057845583__p18813151419118">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.6.1.1.5.1.3 "><p id="en-us_topic_0057845583__p5813191412119">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.6.1.1.5.1.4 "><p id="en-us_topic_0057845583__p681319141013">Password of the IAM user.</p>
|
||
<div class="note" id="en-us_topic_0057845583__note77832141112"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="en-us_topic_0057845583__ul781331411112"><li id="en-us_topic_0057845583__li1981381416117">To obtain a token successfully, ensure that the password you provide is correct.</li><li id="en-us_topic_0057845583__li168137141812">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="en-us_topic_0057845583__b0535194614815">Forgot Password</strong>, and reset the password.</li></ul>
|
||
</div></div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="en-us_topic_0057845583__li19469631442"><a name="en-us_topic_0057845583__li19469631442"></a><a name="li19469631442"></a>auth.identity.password.user.domain
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table197848141115" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__row1381315140120"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.7.1.1.5.1.1"><p id="en-us_topic_0057845583__p1081317141916">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.7.1.1.5.1.2"><p id="en-us_topic_0057845583__p38131414018">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.7.1.1.5.1.3"><p id="en-us_topic_0057845583__p181317143118">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.7.1.1.5.1.4"><p id="en-us_topic_0057845583__p10813101416110">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row1581301417117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.7.1.1.5.1.1 "><p id="en-us_topic_0057845583__p17813814619">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.7.1.1.5.1.2 "><p id="en-us_topic_0057845583__p13813151414110">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.7.1.1.5.1.3 "><p id="en-us_topic_0057845583__p481319141114">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.7.1.1.5.1.4 "><p id="en-us_topic_0057845583__p681313144112">Name of the account used to create the IAM user.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="en-us_topic_0057845583__li152529541647"><a name="en-us_topic_0057845583__li152529541647"></a><a name="li152529541647"></a>auth.scope
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table117861614714" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__row1781411416115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.8.1.1.5.1.1"><p id="en-us_topic_0057845583__p118142148120">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.8.1.1.5.1.2"><p id="en-us_topic_0057845583__p08145146117">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.8.1.1.5.1.3"><p id="en-us_topic_0057845583__p16814614512">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.8.1.1.5.1.4"><p id="en-us_topic_0057845583__p1781431417118">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row108147141813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.8.1.1.5.1.1 "><p id="en-us_topic_0057845583__p28149145114"><a href="#en-us_topic_0057845583__li31351934511">domain</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.8.1.1.5.1.2 "><p id="en-us_topic_0057845583__p1181441418114">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.8.1.1.5.1.3 "><p id="en-us_topic_0057845583__p118141614911">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.8.1.1.5.1.4 "><p id="en-us_topic_0057845583__p1681451416119">If this parameter is set to <strong id="en-us_topic_0057845583__b952011014209">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="en-us_topic_0057845583__b1617011238203">id</strong> or <strong id="en-us_topic_0057845583__b2170723182019">name</strong>. <strong id="en-us_topic_0057845583__b2017018235208">domain.id</strong> is recommended.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row1381419141119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.8.1.1.5.1.1 "><p id="en-us_topic_0057845583__p15814414814"><a href="#en-us_topic_0057845583__li1026951216511">project</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.8.1.1.5.1.2 "><p id="en-us_topic_0057845583__p981420141914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.8.1.1.5.1.3 "><p id="en-us_topic_0057845583__p581481414117">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.8.1.1.5.1.4 "><p id="en-us_topic_0057845583__p128141214517">If this parameter is set to <strong id="en-us_topic_0057845583__b177643458200">project</strong>, the token can be used to access only services (such as ECS) in specific projects. You can specify either <strong id="en-us_topic_0057845583__b135212574206">id</strong> or <strong id="en-us_topic_0057845583__b1552195792017">name</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="en-us_topic_0057845583__li31351934511"><a name="en-us_topic_0057845583__li31351934511"></a><a name="li31351934511"></a>auth.scope.domain
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table578715148120" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__row281415142015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.9.1.1.5.1.1"><p id="en-us_topic_0057845583__p13814514110">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.9.1.1.5.1.2"><p id="en-us_topic_0057845583__p181413141714">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.9.1.1.5.1.3"><p id="en-us_topic_0057845583__p168141914914">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.9.1.1.5.1.4"><p id="en-us_topic_0057845583__p1814614616">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row68141141914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.9.1.1.5.1.1 "><p id="en-us_topic_0057845583__p148141214414">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.9.1.1.5.1.2 "><p id="en-us_topic_0057845583__p1281461414113">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.9.1.1.5.1.3 "><p id="en-us_topic_0057845583__p15814114311">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.9.1.1.5.1.4 "><p id="en-us_topic_0057845583__p0814514314">ID of the account used to create the IAM user.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row148145145119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.9.1.1.5.1.1 "><p id="en-us_topic_0057845583__p16814181416110">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.9.1.1.5.1.2 "><p id="en-us_topic_0057845583__p19814111419117">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.9.1.1.5.1.3 "><p id="en-us_topic_0057845583__p188145141212">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.9.1.1.5.1.4 "><p id="en-us_topic_0057845583__p10814914215">Name of the account used to create the IAM user.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="en-us_topic_0057845583__li1026951216511"><a name="en-us_topic_0057845583__li1026951216511"></a><a name="li1026951216511"></a>auth.scope.project
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table97885141616" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__row08141614315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.10.1.1.5.1.1"><p id="en-us_topic_0057845583__p681431416120">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.10.1.1.5.1.2"><p id="en-us_topic_0057845583__p68141614511">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.10.1.1.5.1.3"><p id="en-us_topic_0057845583__p581414141411">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.10.1.1.5.1.4"><p id="en-us_topic_0057845583__p13814914319">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row48149149119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.10.1.1.5.1.1 "><p id="en-us_topic_0057845583__p1081431411111">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.10.1.1.5.1.2 "><p id="en-us_topic_0057845583__p081413143114">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.10.1.1.5.1.3 "><p id="en-us_topic_0057845583__p381415141017">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.10.1.1.5.1.4 "><p id="en-us_topic_0057845583__p18814114217">ID of the project to which the IAM user belongs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row1081441415117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.10.1.1.5.1.1 "><p id="en-us_topic_0057845583__p38147141913">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.10.1.1.5.1.2 "><p id="en-us_topic_0057845583__p2814191416117">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.10.1.1.5.1.3 "><p id="en-us_topic_0057845583__p1681414141117">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.10.1.1.5.1.4 "><p id="en-us_topic_0057845583__p198144141617">Project name of the account used to create the IAM user.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="en-us_topic_0057845583__en-us_topic_0026585112_li17042198">Example request<p id="en-us_topic_0057845583__a8fbaf401ac2d466888905fc593f3fc49"><a name="en-us_topic_0057845583__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="en-us_topic_0057845583__b13931884549">user A</strong>. The login password of the user is <strong id="en-us_topic_0057845583__b155791839125411">**********</strong> and the domain name is <strong id="en-us_topic_0057845583__b929055511544">domain A</strong>. The scope of the token is <strong id="en-us_topic_0057845583__b148619112556">domain</strong>.</p>
|
||
<pre class="screen" id="en-us_topic_0057845583__screen165731206134">{
|
||
"auth": {
|
||
"identity": {
|
||
"methods": ["password"],
|
||
"password": {
|
||
"user": {
|
||
"name": "user A",
|
||
"password": "**********",
|
||
"domain": {
|
||
"name": "domain A"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"scope": {
|
||
"domain": {
|
||
"name": "domain A"
|
||
}
|
||
}
|
||
}
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="en-us_topic_0057845583__s3a08e13bb5b34dc2ba4dcd84a0d51cf5"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845583__en-us_topic_0026585112_ul10497152"><li id="en-us_topic_0057845583__en-us_topic_0026585112_li27365507">Parameters in the response header
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__en-us_topic_0026585112_table44962972" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__en-us_topic_0026585112_row49143529"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845583__en-us_topic_0026585112_p21202951">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="19.759999999999998%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845583__p1354817920213">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="18.060000000000002%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845583__en-us_topic_0026585112_p39717481">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="40.18%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845583__en-us_topic_0026585112_p62999416">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__en-us_topic_0026585112_row2679067"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p15677883">X-Subject-Token</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19.759999999999998%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845583__p954817912217">Yes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="18.060000000000002%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p61948991">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="40.18%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p51812368">Obtained token.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table025592415478" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response body</caption><thead align="left"><tr id="en-us_topic_0057845583__row8301112494715"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0057845583__p1030122417475">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0057845583__p19301172494718">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0057845583__p18301182411479">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row153011624164715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0057845583__p11301132424714"><a href="#en-us_topic_0057845583__table14259024204717">token</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0057845583__p15301182404720">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0057845583__p19301132417476">Token information.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="en-us_topic_0057845583__table14259024204717"></a><a name="table14259024204717"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table14259024204717" frame="border" border="1" rules="all"><caption><b>Table 3 </b>token</caption><thead align="left"><tr id="en-us_topic_0057845583__row930102474717"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="en-us_topic_0057845583__p10301324124718">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="en-us_topic_0057845583__p9301142424717">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="en-us_topic_0057845583__p183011424184711">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row15301924154719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845583__p1030119247476"><a href="#en-us_topic_0057845583__table18263824174719">catalog</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0057845583__p133011924134713">Array of objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0057845583__p1330162410470">Catalog information.</p>
|
||
<p id="en-us_topic_0057845583__p136415619524">Example:</p>
|
||
<pre class="screen" id="en-us_topic_0057845583__screen16364569522">"catalog": [{
|
||
"type": "identity",
|
||
"id": "1331e5cff2a74d76b03da1225910e...",
|
||
"name": "iam",
|
||
"endpoints": [{
|
||
"url": "<em id="en-us_topic_0057845583__i83645695218">https://sample.domain.com</em>/v3",
|
||
"region": "*",
|
||
"region_id": "*",
|
||
"interface": "public",
|
||
"id": "089d4a381d574308a703122d3ae73..."
|
||
}]
|
||
}]</pre>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row6301192454712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845583__p83011724104716"><a href="#en-us_topic_0057845583__table52641724184711">domain</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0057845583__p193013246477">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0057845583__p73021824124718">Account information about the IAM user who requests for the token. This parameter is returned only when the <strong id="en-us_topic_0057845583__b566312622114">scope</strong> parameter in the request body has been set to <strong id="en-us_topic_0057845583__b566311262218">domain</strong>.</p>
|
||
<p id="en-us_topic_0057845583__p29581832195118">Example:</p>
|
||
<pre class="screen" id="en-us_topic_0057845583__screen295873205116">"domain": {
|
||
"name" : "domain A"
|
||
"id" : "fdec73ffea524aa1b373e40..."</pre>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row183021424144711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845583__p6302224194713">expires_at</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0057845583__p530217246471">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0057845583__p0302122484719">Time when the token will expire.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row14302192484719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845583__p930222410476">mfa_authn_at</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0057845583__p1330213247477">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0057845583__p330212474718">MFA authentication time. This field is displayed only when virtual MFA–based login authentication is enabled.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row1302152424714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845583__p14302102420476">issued_at</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0057845583__p8302122454716">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0057845583__p6302182419478">Time when the token was issued.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row53024246478"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845583__p14302724194717">methods</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0057845583__p1530218246478">Array of strings</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0057845583__p1030212415475">Method for obtaining the token.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row13302224114716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845583__p15302724194711"><a href="#en-us_topic_0057845583__table4265182419474">project</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0057845583__p730212474720">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0057845583__p5302124184712">Project information about the IAM user who requests for the token. This parameter is returned only when the <strong id="en-us_topic_0057845583__b117413419298">scope</strong> parameter in the request body has been set to <strong id="en-us_topic_0057845583__b1274212422918">project</strong>.</p>
|
||
<p id="en-us_topic_0057845583__p51291846175119">Example:</p>
|
||
<pre class="screen" id="en-us_topic_0057845583__screen812924645118">"project": {
|
||
"name": "project A",
|
||
"id": "34c77f3eaf84c00aaf54...",
|
||
"domain": {
|
||
"name": "domain A",
|
||
"id": "fdec73ffea524aa1b373e40..."
|
||
}
|
||
}</pre>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row13302132412473"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845583__p530262434710"><a href="#en-us_topic_0057845583__table1526632404711">roles</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0057845583__p0302102454718">Array of objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0057845583__p153024245479">Permissions information of the token.</p>
|
||
<p id="en-us_topic_0057845583__p1474201785211">Example:</p>
|
||
<pre class="screen" id="en-us_topic_0057845583__screen16741317125219">"roles" : [{
|
||
"name" : "role1",
|
||
"id" : "roleid1"
|
||
}, {
|
||
"name" : "role2",
|
||
"id" : "roleid2"
|
||
}
|
||
] </pre>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row1030211245472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0057845583__p930292414479"><a href="#en-us_topic_0057845583__table926722417478">user</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0057845583__p230292484711">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0057845583__p630292412472">Information about the IAM user who requests for the token.</p>
|
||
<p id="en-us_topic_0057845583__p1456301712518">Example:</p>
|
||
<pre class="screen" id="en-us_topic_0057845583__screen15563131725119">"user": {
|
||
"name": "user A",
|
||
"id": "b95b78b67fa045b38104...",
|
||
"password_expires_at":"2016-11-06T15:32:17.000000",
|
||
"domain": {
|
||
"name": "domain A",
|
||
"id": "fdec73ffea524aa1b373e40..."
|
||
}
|
||
}</pre>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="en-us_topic_0057845583__table18263824174719"></a><a name="table18263824174719"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table18263824174719" frame="border" border="1" rules="all"><caption><b>Table 4 </b>token.catalog</caption><thead align="left"><tr id="en-us_topic_0057845583__row1030212454710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.4.2.4.1.1"><p id="en-us_topic_0057845583__p6302142424716">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.4.2.4.1.2"><p id="en-us_topic_0057845583__p43023241471">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.4.2.4.1.3"><p id="en-us_topic_0057845583__p830372411472">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row130362416475"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="en-us_topic_0057845583__p1930312417476"><a href="#en-us_topic_0057845583__table13263152454713">endpoints</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="en-us_topic_0057845583__p103036247476">Array of objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="en-us_topic_0057845583__p8303424184715">Endpoint information.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row133031524144719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="en-us_topic_0057845583__p6303142464715">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="en-us_topic_0057845583__p113030246476">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="en-us_topic_0057845583__p1030392418476">Service ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row3303024144715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="en-us_topic_0057845583__p17303182474720">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="en-us_topic_0057845583__p1630342416470">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="en-us_topic_0057845583__p10303152454718">Service name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row113035240473"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.2.4.1.1 "><p id="en-us_topic_0057845583__p730382414720">type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.4.2.4.1.2 "><p id="en-us_topic_0057845583__p9303192414716">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.4.2.4.1.3 "><p id="en-us_topic_0057845583__p1303172411478">Type of the service to which the API belongs.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="en-us_topic_0057845583__table13263152454713"></a><a name="table13263152454713"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table13263152454713" frame="border" border="1" rules="all"><caption><b>Table 5 </b>token.catalog.endpoints</caption><thead align="left"><tr id="en-us_topic_0057845583__row530362434718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.5.2.4.1.1"><p id="en-us_topic_0057845583__p12303102420473">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.5.2.4.1.2"><p id="en-us_topic_0057845583__p12303924154712">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.5.2.4.1.3"><p id="en-us_topic_0057845583__p93031324144711">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row3303172411473"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="en-us_topic_0057845583__p173031024144715">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="en-us_topic_0057845583__p193031724104720">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="en-us_topic_0057845583__p030332434715">Endpoint ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row3303192444713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="en-us_topic_0057845583__p193032248471">interface</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="en-us_topic_0057845583__p16303424114712">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="en-us_topic_0057845583__p530316240471">Visibility of the API. <strong id="en-us_topic_0057845583__b845894753416">public</strong> indicates that the API is available for public access.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row1030342410471"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="en-us_topic_0057845583__p1930322404717">region</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="en-us_topic_0057845583__p8303112434712">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="en-us_topic_0057845583__p73032247470">Region to which the endpoint belongs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row3303124104713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="en-us_topic_0057845583__p23031924114716">region_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="en-us_topic_0057845583__p1130313241474">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="en-us_topic_0057845583__p8303102464720">Region ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row10303142444710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.4.1.1 "><p id="en-us_topic_0057845583__p1630372415478">url</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.5.2.4.1.2 "><p id="en-us_topic_0057845583__p43039247471">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.5.2.4.1.3 "><p id="en-us_topic_0057845583__p13031124184713">Endpoint URL.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="en-us_topic_0057845583__table52641724184711"></a><a name="table52641724184711"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table52641724184711" frame="border" border="1" rules="all"><caption><b>Table 6 </b>token.domain</caption><thead align="left"><tr id="en-us_topic_0057845583__row330322434714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.6.2.4.1.1"><p id="en-us_topic_0057845583__p1430313242473">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.6.2.4.1.2"><p id="en-us_topic_0057845583__p1030382404715">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.6.2.4.1.3"><p id="en-us_topic_0057845583__p173031524134712">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row030332412472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="en-us_topic_0057845583__p53031024104710">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="en-us_topic_0057845583__p2303132420477">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="en-us_topic_0057845583__p330342419476">Domain name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row13037243474"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.6.2.4.1.1 "><p id="en-us_topic_0057845583__p1930372416474">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.6.2.4.1.2 "><p id="en-us_topic_0057845583__p10303182415472">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.6.2.4.1.3 "><p id="en-us_topic_0057845583__p63031242470">Domain ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="en-us_topic_0057845583__table4265182419474"></a><a name="table4265182419474"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table4265182419474" frame="border" border="1" rules="all"><caption><b>Table 7 </b>token.project</caption><thead align="left"><tr id="en-us_topic_0057845583__row33032247470"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.7.2.4.1.1"><p id="en-us_topic_0057845583__p83031624154714">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.7.2.4.1.2"><p id="en-us_topic_0057845583__p230316242475">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.7.2.4.1.3"><p id="en-us_topic_0057845583__p19303624184719">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row230315249470"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="en-us_topic_0057845583__p1530382413475">domain</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="en-us_topic_0057845583__p15303162412474">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="en-us_topic_0057845583__p1330311240474">Domain information of the project.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row430352412475"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="en-us_topic_0057845583__p530302416479">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="en-us_topic_0057845583__p730362410476">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="en-us_topic_0057845583__p15303524174710">Project ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row133031224144713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.7.2.4.1.1 "><p id="en-us_topic_0057845583__p93031224154719">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.7.2.4.1.2 "><p id="en-us_topic_0057845583__p16303524174718">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.7.2.4.1.3 "><p id="en-us_topic_0057845583__p13303122411477">Project name.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table126517242479" frame="border" border="1" rules="all"><caption><b>Table 8 </b>token.project.domain</caption><thead align="left"><tr id="en-us_topic_0057845583__row133031924174716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.8.2.4.1.1"><p id="en-us_topic_0057845583__p17303152434716">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.8.2.4.1.2"><p id="en-us_topic_0057845583__p153031824184718">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.8.2.4.1.3"><p id="en-us_topic_0057845583__p3303112416473">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row43032245471"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="en-us_topic_0057845583__p530312414473">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="en-us_topic_0057845583__p530314246477">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="en-us_topic_0057845583__p153041524194718">Domain ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row93041424144717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.8.2.4.1.1 "><p id="en-us_topic_0057845583__p530414243479">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.8.2.4.1.2 "><p id="en-us_topic_0057845583__p0304142424714">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.8.2.4.1.3 "><p id="en-us_topic_0057845583__p1130442415479">Domain name.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="en-us_topic_0057845583__table1526632404711"></a><a name="table1526632404711"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table1526632404711" frame="border" border="1" rules="all"><caption><b>Table 9 </b>token.roles</caption><thead align="left"><tr id="en-us_topic_0057845583__row03041424134720"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.9.2.4.1.1"><p id="en-us_topic_0057845583__p1630411243471">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.9.2.4.1.2"><p id="en-us_topic_0057845583__p183041424204717">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.9.2.4.1.3"><p id="en-us_topic_0057845583__p153041324144711">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row6304202410474"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.9.2.4.1.1 "><p id="en-us_topic_0057845583__p16304124154713">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.9.2.4.1.2 "><p id="en-us_topic_0057845583__p1304122420473">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.9.2.4.1.3 "><p id="en-us_topic_0057845583__p53041824194715">Permission name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row1330472424715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.9.2.4.1.1 "><p id="en-us_topic_0057845583__p7304182413473">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.9.2.4.1.2 "><p id="en-us_topic_0057845583__p16304102413474">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.9.2.4.1.3 "><p id="en-us_topic_0057845583__p2304224174714">Permission ID. The default value is <strong id="en-us_topic_0057845583__b1964861163519">0</strong>, which does not correspond to any permission.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="en-us_topic_0057845583__table926722417478"></a><a name="table926722417478"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table926722417478" frame="border" border="1" rules="all"><caption><b>Table 10 </b>token.user</caption><thead align="left"><tr id="en-us_topic_0057845583__row123042245473"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.10.2.4.1.1"><p id="en-us_topic_0057845583__p20304172454713">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.10.2.4.1.2"><p id="en-us_topic_0057845583__p1530482424712">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.10.2.4.1.3"><p id="en-us_topic_0057845583__p12304824124711">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row1130420242477"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.10.2.4.1.1 "><p id="en-us_topic_0057845583__p16304724184720">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.10.2.4.1.2 "><p id="en-us_topic_0057845583__p73041124144711">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.10.2.4.1.3 "><p id="en-us_topic_0057845583__p6304182404712">IAM username.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row183043246472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.10.2.4.1.1 "><p id="en-us_topic_0057845583__p14304102413477">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.10.2.4.1.2 "><p id="en-us_topic_0057845583__p8304142411478">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.10.2.4.1.3 "><p id="en-us_topic_0057845583__p930412444710">IAM user ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row18304152484717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.10.2.4.1.1 "><p id="en-us_topic_0057845583__p43041324184712">password_expires_at</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.10.2.4.1.2 "><p id="en-us_topic_0057845583__p1130432424710">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.10.2.4.1.3 "><p id="en-us_topic_0057845583__p33049242477">Password expiration time. If this parameter is set to <strong id="en-us_topic_0057845583__b209331314310">null</strong>, the password will never expire.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row10304132414715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.10.2.4.1.1 "><p id="en-us_topic_0057845583__p5304172418470"><a href="#en-us_topic_0057845583__table202681724204710">domain</a></p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.10.2.4.1.2 "><p id="en-us_topic_0057845583__p103041824184717">Object</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.10.2.4.1.3 "><p id="en-us_topic_0057845583__p18304162474712">Information about the account used to create the IAM user.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="en-us_topic_0057845583__table202681724204710"></a><a name="table202681724204710"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__table202681724204710" frame="border" border="1" rules="all"><caption><b>Table 11 </b>token.user.domain</caption><thead align="left"><tr id="en-us_topic_0057845583__row163041224124713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.11.2.4.1.1"><p id="en-us_topic_0057845583__p1530416244474">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.11.2.4.1.2"><p id="en-us_topic_0057845583__p230482494713">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.11.2.4.1.3"><p id="en-us_topic_0057845583__p93041224134717">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__row83048245472"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.11.2.4.1.1 "><p id="en-us_topic_0057845583__p8304132415474">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.11.2.4.1.2 "><p id="en-us_topic_0057845583__p1030432417470">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.11.2.4.1.3 "><p id="en-us_topic_0057845583__p123046249474">Name of the account used to create the IAM user.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__row53041224144713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.11.2.4.1.1 "><p id="en-us_topic_0057845583__p230412249472">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.11.2.4.1.2 "><p id="en-us_topic_0057845583__p63041724164720">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.11.2.4.1.3 "><p id="en-us_topic_0057845583__p11304182444717">ID of the account used to create the IAM user.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="en-us_topic_0057845583__lf3c28402a2ee4844bc99946ea67bf82d">Example response<div class="p" id="en-us_topic_0057845583__p01640289481"><a name="en-us_topic_0057845583__lf3c28402a2ee4844bc99946ea67bf82d"></a><a name="lf3c28402a2ee4844bc99946ea67bf82d"></a>The following is a sample request for obtaining a token for <strong id="en-us_topic_0057845583__b2084782396">user A</strong>. The login password of the user is <strong id="en-us_topic_0057845583__b1581073947">**********</strong> and the domain name is <strong id="en-us_topic_0057845583__b762935778">domain A</strong>. The scope of the token is <strong id="en-us_topic_0057845583__b1775867536">domain</strong>.<pre class="screen" id="en-us_topic_0057845583__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="en-us_topic_0057845583__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>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="en-us_topic_0057845583__sbfe93ca4c2b9427dbb2218a4e72da6a8"><h4 class="sectiontitle">Status Codes</h4>
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845583__en-us_topic_0026585112_table34550710" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845583__en-us_topic_0026585112_row8352109"><th align="left" class="cellrowborder" valign="top" width="27.52%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845583__en-us_topic_0026585112_p5432205">Status Code</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="72.48%" id="mcps1.3.5.2.1.3.1.2"><p id="en-us_topic_0057845583__en-us_topic_0026585112_p37355470">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="en-us_topic_0057845583__en-us_topic_0026585112_row5894231"><td class="cellrowborder" valign="top" width="27.52%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p7670737">201</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="72.48%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p17349988">The request is successful.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__en-us_topic_0026585112_row21932166"><td class="cellrowborder" valign="top" width="27.52%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p31674992">400</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="72.48%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p15537542">The server failed to process the request.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__r22bf632ff3984ffbaa2734a029063cfb"><td class="cellrowborder" valign="top" width="27.52%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p947606916650">401</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="72.48%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845583__a3a62e2f9d6c84b4083dfb8b2ade8e14c">Authentication failed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__r41d0d854619349f898c16f7c61792083"><td class="cellrowborder" valign="top" width="27.52%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p762821816657">403</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="72.48%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845583__a0261fc1955104ca3b1f0a46388724624">Access denied.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__rea66e1a745ee4e0882be6b9f5349ac4d"><td class="cellrowborder" valign="top" width="27.52%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p486971841676">404</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="72.48%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p521578261676">The requested resource cannot be found.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__r230ba1b5ddec4cd0a41a5c37806e60f5"><td class="cellrowborder" valign="top" width="27.52%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845583__af8f4513c90d344e3b90952b53e3ee015">500</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="72.48%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845583__a19c27fd6b377464898ec6cae5778ec80">Internal server error. The format may be incorrect.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="en-us_topic_0057845583__en-us_topic_0026585112_row6824316711"><td class="cellrowborder" valign="top" width="27.52%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845583__en-us_topic_0026585112_p61418816711">503</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="72.48%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845583__a4bc003bda05e465eb3a3f0f989888213">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>
|
||
|