forked from docs/doc-exports
Wei, Hongmin
80f18fd272
Reviewed-by: Kabai, Zoltán Gábor <zoltan-gabor.kabai@t-systems.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
657 lines
42 KiB
HTML
657 lines
42 KiB
HTML
<a name="iam_13_0605"></a><a name="iam_13_0605"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining a Token with an OpenID Connect ID Token</h1>
|
|
<div id="body1598526655527"><div class="section" id="iam_13_0605__section2362256104318"><h4 class="sectiontitle">Function</h4><p id="iam_13_0605__p195501156174313">This API is used to obtain a federated identity authentication token using an OpenID Connect ID token.</p>
|
|
</div>
|
|
<div class="section" id="iam_13_0605__section8363155664310"><h4 class="sectiontitle">URI</h4><p id="iam_13_0605__p14550656104310">POST /v3.0/OS-AUTH/id-token/tokens</p>
|
|
</div>
|
|
<div class="section" id="iam_13_0605__section1936317562438"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table183641556104314" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_13_0605__row855013565432"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_13_0605__p955175618433">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.2.2.5.1.2"><p id="iam_13_0605__p15551256114317">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="iam_13_0605__p955125614434">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.5.1.4"><p id="iam_13_0605__p655119562433">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row9551105617439"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_13_0605__p17551155619432">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_13_0605__p1055112563438">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_13_0605__p1551185664313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_13_0605__p1355114564434">Fill <strong id="iam_13_0605__b615175113436">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row05511156124320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_13_0605__p85511356134310">X-Idp-Id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_13_0605__p5551856154312">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_13_0605__p5551195634311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_13_0605__p115517565437">Identity provider ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table10368155610434" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request body</caption><thead align="left"><tr id="iam_13_0605__row1655105664315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="iam_13_0605__p155511756164315">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.3.2.5.1.2"><p id="iam_13_0605__p555135674319">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="iam_13_0605__p1455125611437">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.5.1.4"><p id="iam_13_0605__p355125654316">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row3551356194314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="iam_13_0605__p14551125644319"><a href="#iam_13_0605__table2037015569431">auth</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="iam_13_0605__p655185610430">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="iam_13_0605__p1155115674318">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="iam_13_0605__p165511356164320">Details about the <strong id="iam_13_0605__b1878925144511">auth</strong> request parameter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table2037015569431"></a><a name="table2037015569431"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table2037015569431" frame="border" border="1" rules="all"><caption><b>Table 3 </b>GetIdTokenAuthParams</caption><thead align="left"><tr id="iam_13_0605__row75516566439"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="iam_13_0605__p35519563439">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.4.2.5.1.2"><p id="iam_13_0605__p255117563431">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="iam_13_0605__p6551856184315">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.4.2.5.1.4"><p id="iam_13_0605__p1455115654317">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row955165664316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_13_0605__p1755116563438"><a href="#iam_13_0605__table18374185617432">id_token</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_13_0605__p2551165613430">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_13_0605__p8551456144318">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_13_0605__p15551556204310">Details about an ID token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row2551856104311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_13_0605__p20551456184316"><a href="#iam_13_0605__table203761056124311">scope</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_13_0605__p1055185674317">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_13_0605__p955110568432">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_13_0605__p6551195694318">Permission scope of the token you want to obtain. An unscoped token will be obtained if this parameter is not specified.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table18374185617432"></a><a name="table18374185617432"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table18374185617432" frame="border" border="1" rules="all"><caption><b>Table 4 </b>GetIdTokenIdTokenBody</caption><thead align="left"><tr id="iam_13_0605__row955165614313"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="iam_13_0605__p1755165615433">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.5.2.5.1.2"><p id="iam_13_0605__p12551205617435">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="iam_13_0605__p755113564438">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.5.2.5.1.4"><p id="iam_13_0605__p2551165674311">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row19551056154316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="iam_13_0605__p18551165619433">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.5.2.5.1.2 "><p id="iam_13_0605__p755135613435">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="iam_13_0605__p355115568430">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.5.2.5.1.4 "><p id="iam_13_0605__p95511567434">ID token, which is constructed by the enterprise IdP to carry the identity information of federated users. For details about how to obtain an ID token, see the enterprise IdP documentation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table203761056124311"></a><a name="table203761056124311"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table203761056124311" frame="border" border="1" rules="all"><caption><b>Table 5 </b>GetIdTokenIdScopeBody</caption><thead align="left"><tr id="iam_13_0605__row9551656144316"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="iam_13_0605__p255110568434">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.6.2.5.1.2"><p id="iam_13_0605__p7551115664319">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="iam_13_0605__p1855125604313">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.6.2.5.1.4"><p id="iam_13_0605__p455111563435">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row255115664320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="iam_13_0605__p105511056154311"><a href="#iam_13_0605__table1379356134320">domain</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.6.2.5.1.2 "><p id="iam_13_0605__p1255111564431">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="iam_13_0605__p1955145615431">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.6.2.5.1.4 "><p id="iam_13_0605__p13551115654319">Domain scope details. Specify a domain or a project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row11551115612433"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="iam_13_0605__p1551156154313"><a href="#iam_13_0605__table1379356134320">project</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.6.2.5.1.2 "><p id="iam_13_0605__p20551256124316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="iam_13_0605__p135511456164315">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.6.2.5.1.4 "><p id="iam_13_0605__p11551135614314">Project scope details. Specify a project or a domain.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table1379356134320"></a><a name="table1379356134320"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table1379356134320" frame="border" border="1" rules="all"><caption><b>Table 6 </b>GetIdTokenScopeDomainOrProjectBody</caption><thead align="left"><tr id="iam_13_0605__row45518569433"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.1"><p id="iam_13_0605__p1455175614317">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.7.2.5.1.2"><p id="iam_13_0605__p1055155616433">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.3"><p id="iam_13_0605__p155105613438">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.7.2.5.1.4"><p id="iam_13_0605__p1055225604320">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row1655225674318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="iam_13_0605__p15521156174311">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.7.2.5.1.2 "><p id="iam_13_0605__p19552175613433">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="iam_13_0605__p135521556124312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.7.2.5.1.4 "><p id="iam_13_0605__p75521056104312">Domain ID or project ID. Specify either this parameter or the <strong id="iam_13_0605__b1479515714500">name</strong> parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row12552256164314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="iam_13_0605__p1155213561436">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.7.2.5.1.2 "><p id="iam_13_0605__p2552105610433">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="iam_13_0605__p255245644311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.7.2.5.1.4 "><p id="iam_13_0605__p195521956154312">Domain name or project name. Specify either this parameter or the <strong id="iam_13_0605__b137581510205020">id</strong> parameter.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_13_0605__section1438335617433"><h4 class="sectiontitle">Response Parameters</h4><p id="iam_13_0605__p9552185684317"><strong id="iam_13_0605__b55191127145013">Status code: 201</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table1338435654314" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameters in the response header</caption><thead align="left"><tr id="iam_13_0605__row1455245614316"><th align="left" class="cellrowborder" valign="top" width="19.81%" id="mcps1.3.4.3.2.4.1.1"><p id="iam_13_0605__p855275654312">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.19%" id="mcps1.3.4.3.2.4.1.2"><p id="iam_13_0605__p055245644313">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="iam_13_0605__p1555255694315">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row165527561434"><td class="cellrowborder" valign="top" width="19.81%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_13_0605__p1555235604310">X-Subject-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.19%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_13_0605__p65521556184313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_13_0605__p17552656124313">Signed token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table138695604315" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Parameters in the response body</caption><thead align="left"><tr id="iam_13_0605__row1455218569433"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="iam_13_0605__p65526561436">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="iam_13_0605__p75522566434">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="iam_13_0605__p11552195619439">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row14552756204312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_13_0605__p13552756174316"><a href="#iam_13_0605__table103881956114312">token</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_13_0605__p175523565439">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_13_0605__p9552156134310">Details about the obtained token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table103881956114312"></a><a name="table103881956114312"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table103881956114312" frame="border" border="1" rules="all"><caption><b>Table 9 </b>ScopedTokenInfo</caption><thead align="left"><tr id="iam_13_0605__row185527563436"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="iam_13_0605__p6552145614315">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="iam_13_0605__p13552125624315">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="iam_13_0605__p13552155616433">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row20552175610434"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0605__p11552135619432">expires_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0605__p855225615430">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_13_0605__p1455218563434">Time when the token will expire.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row355217567436"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0605__p17552185674313">methods</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0605__p955245624311">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_13_0605__p18552456114314">Method for obtaining the token. For federated users, the default value of this parameter is <strong id="iam_13_0605__b139604685117">mapped</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row145521556184318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0605__p8552356134316">issued_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0605__p1455217568432">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_13_0605__p65526561433">Time when the token was issued.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row17552356144318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0605__p155521656104316"><a href="#iam_13_0605__table63957566436">user</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0605__p13552656124316">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_13_0605__p10552456154313">User details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row1055285624312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0605__p8552556174313"><a href="#iam_13_0605__table104051456104311">domain</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0605__p255245613439">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_13_0605__p555215619437">Domain details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row4552175674315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0605__p5552956134317"><a href="#iam_13_0605__table18407115614438">project</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0605__p1055245615435">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_13_0605__p1655245616437">Project details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row19552756134310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0605__p255265620438">role</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0605__p185521456104316">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_13_0605__p1955255664314">Policy details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row1855225664314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0605__p6552135614437"><a href="#iam_13_0605__table14410115674311">catalog</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0605__p195526568439">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_13_0605__p7552115644313">Catalog details.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table63957566436"></a><a name="table63957566436"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table63957566436" frame="border" border="1" rules="all"><caption><b>Table 10 </b>FederationUserBody</caption><thead align="left"><tr id="iam_13_0605__row1655295654312"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="iam_13_0605__p655217567435">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="iam_13_0605__p11552145610431">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="iam_13_0605__p14552105624314">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row1455275617431"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="iam_13_0605__p12552156134314"><a href="#iam_13_0605__table1739620561434">OS-FEDERATION</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="iam_13_0605__p1955216569437">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="iam_13_0605__p65523566431">Federated user details.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table1739620561434"></a><a name="table1739620561434"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table1739620561434" frame="border" border="1" rules="all"><caption><b>Table 11 </b>OSFederationInfo</caption><thead align="left"><tr id="iam_13_0605__row2553156104311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="iam_13_0605__p16553115614316">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="iam_13_0605__p85531956174312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="iam_13_0605__p05531956134310">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row19553356184319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0605__p855315569432"><a href="#iam_13_0605__table1401155654314">identify_provider</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="iam_13_0605__p1955316561431">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0605__p155531656144319">Identity provider details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row5553165684312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0605__p15553135619430"><a href="#iam_13_0605__table1440310561432">protocol</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="iam_13_0605__p1955375654313">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0605__p7553155618434">Protocol details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row755325617433"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0605__p7553145694310">groups</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="iam_13_0605__p4553105614315">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0605__p7553115664314">User group details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row205531556104311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0605__p17553195616438"><a href="#iam_13_0605__table104051456104311">domain</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="iam_13_0605__p15530567435">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0605__p1155395610439">Domain details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row19553356144315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0605__p955385664319">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="iam_13_0605__p17553656154318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0605__p6553115654319">User ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row1553155611439"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0605__p8553156114312">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="iam_13_0605__p1455395684310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0605__p16553205611438">Username.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table1401155654314"></a><a name="table1401155654314"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table1401155654314" frame="border" border="1" rules="all"><caption><b>Table 12 </b>IdpIdInfo</caption><thead align="left"><tr id="iam_13_0605__row855395634311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="iam_13_0605__p05531456134314">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="iam_13_0605__p755375613433">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="iam_13_0605__p16553145611431">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row5553155604311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="iam_13_0605__p1855385674312">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="iam_13_0605__p5553185613437">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="iam_13_0605__p135531956134315">Identity provider ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table1440310561432"></a><a name="table1440310561432"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table1440310561432" frame="border" border="1" rules="all"><caption><b>Table 13 </b>ProtocolIdInfo</caption><thead align="left"><tr id="iam_13_0605__row55531756154317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="iam_13_0605__p45532056164319">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="iam_13_0605__p755385620433">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="iam_13_0605__p20553125617439">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row11553356144315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="iam_13_0605__p95531156134314">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="iam_13_0605__p1155385664316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="iam_13_0605__p255345654311">Protocol ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table104051456104311"></a><a name="table104051456104311"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table104051456104311" frame="border" border="1" rules="all"><caption><b>Table 14 </b>DomainInfo</caption><thead align="left"><tr id="iam_13_0605__row20553105620437"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="iam_13_0605__p155531956154316">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p id="iam_13_0605__p1755395619437">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p id="iam_13_0605__p1555365644315">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row175536561434"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="iam_13_0605__p1955355614433">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="iam_13_0605__p9553356144313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="iam_13_0605__p555325624311">Domain ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row195531356144311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="iam_13_0605__p1755335610433">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="iam_13_0605__p3553115618430">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="iam_13_0605__p20553105614433">Domain name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table18407115614438"></a><a name="table18407115614438"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table18407115614438" frame="border" border="1" rules="all"><caption><b>Table 15 </b>ProjectInfo</caption><thead align="left"><tr id="iam_13_0605__row155531756124315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="iam_13_0605__p1055355664313">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="iam_13_0605__p1055375619435">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="iam_13_0605__p7553165634314">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row115531356114311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="iam_13_0605__p14553165634312"><a href="#iam_13_0605__table104051456104311">domain</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="iam_13_0605__p125531656154317">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="iam_13_0605__p15553556164319">Domain details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row1855312563430"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="iam_13_0605__p17553165614434">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="iam_13_0605__p155325654317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="iam_13_0605__p7553115674313">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row7553165610438"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="iam_13_0605__p14553175684312">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="iam_13_0605__p25531056104312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="iam_13_0605__p175531556104317">Project name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0605__table14410115674311"></a><a name="table14410115674311"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table14410115674311" frame="border" border="1" rules="all"><caption><b>Table 16 </b>CatalogInfo</caption><thead align="left"><tr id="iam_13_0605__row255305674311"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.1"><p id="iam_13_0605__p1155405624310">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.2"><p id="iam_13_0605__p255495610439">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.12.2.4.1.3"><p id="iam_13_0605__p55541656114316">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row455419560430"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="iam_13_0605__p105541856164310">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="iam_13_0605__p10554165617438">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="iam_13_0605__p10554175614314">Endpoint ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row5554165644320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="iam_13_0605__p3554115612438">interface</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="iam_13_0605__p1455412563434">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="iam_13_0605__p655420567435">Visibility of the API. <strong id="iam_13_0605__b17200195911813">public</strong> indicates that the API is available for public access.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row355413569433"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="iam_13_0605__p14554125611438">region</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="iam_13_0605__p195541456124314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="iam_13_0605__p95541256154313">Region to which the endpoint belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row1655445610430"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="iam_13_0605__p1455475624318">region_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="iam_13_0605__p1155418562431">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="iam_13_0605__p16554556174313">Region ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row2055425634315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="iam_13_0605__p19554205684313">url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="iam_13_0605__p3554135617438">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="iam_13_0605__p1555125611439">Endpoint URL.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_13_0605__section2414185619435"><h4 class="sectiontitle">Example Request</h4><ul id="iam_13_0605__ul45551156134316"><li id="iam_13_0605__li255513562431">Request for obtaining a scoped token for a specific project<pre class="screen" id="iam_13_0605__screen14485102116509">POST /v3.0/OS-AUTH/id-token/tokens
|
|
|
|
{
|
|
"auth" : {
|
|
"id_token" : {
|
|
"id" : "eyJhbGciOiJSU..."
|
|
},
|
|
"scope" : {
|
|
"project" : {
|
|
"id" : "46419baef4324...",
|
|
"name" : "project name"
|
|
}
|
|
}
|
|
}
|
|
}</pre>
|
|
</li><li id="iam_13_0605__li55558562434">Request for obtaining a scoped token for a specific domain<pre class="screen" id="iam_13_0605__screen115802614504">POST /v3.0/OS-AUTH/id-token/tokens
|
|
|
|
{
|
|
"auth" : {
|
|
"id_token" : {
|
|
"id" : "eyJhbGciOiJSU..."
|
|
},
|
|
"scope" : {
|
|
"domain" : {
|
|
"id" : "063bb260a480...",
|
|
"name" : "IAMDomain"
|
|
}
|
|
}
|
|
}
|
|
}</pre>
|
|
</li><li id="iam_13_0605__li3555155615439">Request for obtaining an unscoped token<pre class="screen" id="iam_13_0605__screen1347418299508">POST /v3.0/OS-AUTH/id-token/tokens
|
|
|
|
{
|
|
"auth" : {
|
|
"id_token" : {
|
|
"id" : "eyJhbGciOiJSU..."
|
|
}
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="iam_13_0605__section144171756164316"><h4 class="sectiontitle">Example Response</h4><p id="iam_13_0605__p855515568434"><strong id="iam_13_0605__b834122815209">Status code: 201</strong></p>
|
|
<p id="iam_13_0605__p2555105619437">The token is obtained successfully.</p>
|
|
<pre class="screen" id="iam_13_0605__screen20555165674318">{
|
|
"token" : {
|
|
"expires_at" : "2018-03-13T03:00:01.168000Z",
|
|
"methods" : [ "mapped" ],
|
|
"issued_at" : "2018-03-12T03:00:01.168000Z",
|
|
"user" : {
|
|
"OS-FEDERATION" : {
|
|
"identity_provider" : {
|
|
"id" : "idptest"
|
|
},
|
|
"protocol" : {
|
|
"id" : "oidc"
|
|
},
|
|
"groups" : [ {
|
|
"name" : "admin",
|
|
"id" : "45a8c8f..."
|
|
} ]
|
|
},
|
|
"domain" : {
|
|
"id" : "063bb260a480...",
|
|
"name" : "IAMDomain"
|
|
},
|
|
"name" : "FederationUser",
|
|
"id" : "suvmgvUZc4PaCOEc..."
|
|
}
|
|
}
|
|
}</pre>
|
|
<p id="iam_13_0605__p1655511563435"><strong id="iam_13_0605__b118371822182312">Status code: 400</strong></p>
|
|
<p id="iam_13_0605__p1755515560432">The server failed to process the request.</p>
|
|
<pre class="screen" id="iam_13_0605__screen14555165610430">{
|
|
"error_msg" : "Request body is invalid.",
|
|
"error_code" : "IAM.0011"
|
|
}</pre>
|
|
<p id="iam_13_0605__p9555756144314"><strong id="iam_13_0605__b10123162818237">Status code: 401</strong></p>
|
|
<p id="iam_13_0605__p205551756204313">Authentication failed.</p>
|
|
<pre class="screen" id="iam_13_0605__screen115551056154314">{
|
|
"error_msg" : "The request you have made requires authentication.",
|
|
"error_code" : "IAM.0001"
|
|
}</pre>
|
|
<p id="iam_13_0605__p655585614315"><strong id="iam_13_0605__b2649123011235">Status code: 403</strong></p>
|
|
<p id="iam_13_0605__p155595634311">Access denied.</p>
|
|
<pre class="screen" id="iam_13_0605__screen255510560432">{
|
|
"error_msg" : "Policy doesn't allow %(actions)s to be performed.",
|
|
"error_code" : "IAM.0003"
|
|
}</pre>
|
|
<p id="iam_13_0605__p11555105614317"><strong id="iam_13_0605__b1011353315236">Status code: 404</strong></p>
|
|
<p id="iam_13_0605__p14556556104312">The requested resource cannot be found.</p>
|
|
<pre class="screen" id="iam_13_0605__screen6556956174312">{
|
|
"error_msg" : "Could not find %(target)s: %(target_id)s.",
|
|
"error_code" : "IAM.0004"
|
|
}</pre>
|
|
<p id="iam_13_0605__p65561356184312"><strong id="iam_13_0605__b62591935182315">Status code: 500</strong></p>
|
|
<p id="iam_13_0605__p1755605619436">Internal system error.</p>
|
|
<pre class="screen" id="iam_13_0605__screen3556185644317">{
|
|
"error_msg" : "An unexpected error prevented the server from fulfilling your request.",
|
|
"error_code" : "IAM.0006"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="iam_13_0605__section5422195614432"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0605__table13422205664311" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_13_0605__row9556105624310"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="iam_13_0605__p145561256174317">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_13_0605__p655611561434">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0605__row1755675604312"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0605__p10556175684313">201</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0605__p355612565437">The token is obtained successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row175561256104314"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0605__p6556175616432">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0605__p18556175612432">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row13556175604315"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0605__p1556656144312">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0605__p9556175616432">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row45561856154318"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0605__p1755610566434">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0605__p35561156194316">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row13556195615436"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0605__p1955675616433">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0605__p1556115615439">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0605__row11556256104319"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0605__p1855675634313">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0605__p17556256164313">Internal system error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845565.html">Token</a></div>
|
|
</div>
|
|
</div>
|
|
|