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>
406 lines
25 KiB
HTML
406 lines
25 KiB
HTML
<a name="iam_13_0606"></a><a name="iam_13_0606"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining an Unscoped Token with an OpenID Connect ID Token</h1>
|
|
<div id="body1598526655527"><div class="section" id="iam_13_0606__section1623114500505"><h4 class="sectiontitle">Function</h4><p id="iam_13_0606__p184511750115018">This API is used to obtain an unscoped token using an OpenID Connect ID token.</p>
|
|
</div>
|
|
<div class="section" id="iam_13_0606__section4233750175014"><h4 class="sectiontitle">URI</h4><p id="iam_13_0606__p245185095012">POST /v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}/auth</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0606__table2234195015509" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="iam_13_0606__row145125065019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="iam_13_0606__p4451850145015">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.2.3.2.5.1.2"><p id="iam_13_0606__p3451195014508">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="iam_13_0606__p10451195010508">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.3.2.5.1.4"><p id="iam_13_0606__p174511250205016">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0606__row245195020506"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_13_0606__p5451195013503">idp_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_13_0606__p19451115020505">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_13_0606__p34511350165011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_13_0606__p19451350135011">Identity provider ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row3451185019501"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_13_0606__p84511350145010">protocol_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_13_0606__p17451155075020">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_13_0606__p1245110505500">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_13_0606__p1845125010502">Protocol ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_13_0606__section1924417505508"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0606__table62449504503" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_13_0606__row11451165065017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_13_0606__p14451105019503">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_0606__p114516502506">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_0606__p124511150135012">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_0606__p145175065017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0606__row1645145014507"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_13_0606__p14451750105010">Authorization</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_13_0606__p145165018502">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_13_0606__p1745145018502">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_13_0606__p7451145065011">ID token of the identity provider. The format is <strong id="iam_13_0606__b7378403188">Bearer</strong> <em id="iam_13_0606__i1059614448182">{ID Token}</em>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_13_0606__section6250450135016"><h4 class="sectiontitle">Response Parameters</h4><p id="iam_13_0606__p18451145018505"><strong id="iam_13_0606__b1622124813181">Status code: 201</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0606__table1425216502504" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response header</caption><thead align="left"><tr id="iam_13_0606__row64511750165011"><th align="left" class="cellrowborder" valign="top" width="19.6%" id="mcps1.3.4.3.2.4.1.1"><p id="iam_13_0606__p1451195018509">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.44%" id="mcps1.3.4.3.2.4.1.2"><p id="iam_13_0606__p345195013500">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59.96%" id="mcps1.3.4.3.2.4.1.3"><p id="iam_13_0606__p124511505504">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0606__row445165011503"><td class="cellrowborder" valign="top" width="19.6%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_13_0606__p1545185015012">X-Subject-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.44%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_13_0606__p8451175018505">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.96%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_13_0606__p4451050135017">Signed token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0606__table1926113500501" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameters in the response body</caption><thead align="left"><tr id="iam_13_0606__row1845118502508"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="iam_13_0606__p16451650155014">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_0606__p1245125016506">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_0606__p6451155045015">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0606__row74511650175012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_13_0606__p14513509507"><a href="#iam_13_0606__table1026565014509">token</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_13_0606__p145175065016">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_13_0606__p1745115085011">Details about the obtained token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0606__table1026565014509"></a><a name="table1026565014509"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0606__table1026565014509" frame="border" border="1" rules="all"><caption><b>Table 5 </b>UnscopedTokenInfo</caption><thead align="left"><tr id="iam_13_0606__row74517502504"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="iam_13_0606__p1645145075016">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_0606__p15451185015509">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_0606__p94511509503">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0606__row1645115017501"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0606__p164513505503">expires_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0606__p245205085018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_13_0606__p845219507503">Time when the token will expire.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row945212507502"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0606__p045211509502">methods</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0606__p745265016506">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_0606__p0452145055019">Token obtaining method. The default value for federated authentication is <strong id="iam_13_0606__b259017522203">mapped</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row7452105016509"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0606__p0452450175013">issued_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0606__p74522050185014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_13_0606__p12452115018506">Time when the token was issued.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row745225016509"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="iam_13_0606__p3452950185014"><a href="#iam_13_0606__table1727255020503">user</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="iam_13_0606__p7452165045020">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="iam_13_0606__p545211501509">User details.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0606__table1727255020503"></a><a name="table1727255020503"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0606__table1727255020503" frame="border" border="1" rules="all"><caption><b>Table 6 </b>FederationUserBody</caption><thead align="left"><tr id="iam_13_0606__row11452185085019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="iam_13_0606__p1745295018500">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_0606__p545235017500">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_0606__p945245019509">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0606__row144521550155012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="iam_13_0606__p94521050175011"><a href="#iam_13_0606__table10275125045010">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_0606__p18452950145019">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="iam_13_0606__p1545211502504">Federated user details.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0606__table10275125045010"></a><a name="table10275125045010"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0606__table10275125045010" frame="border" border="1" rules="all"><caption><b>Table 7 </b>OSFederationInfo</caption><thead align="left"><tr id="iam_13_0606__row7452155019502"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="iam_13_0606__p184521508508">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_0606__p19452155020509">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_0606__p184521450135019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0606__row64521350195018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0606__p345275065017"><a href="#iam_13_0606__table328505075012">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_0606__p5452165019505">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0606__p9452105017508">Identity provider details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row20452150185020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0606__p154526509509"><a href="#iam_13_0606__table52881350195012">protocol</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="iam_13_0606__p1545210500508">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0606__p145295014502">Protocol details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row24521650125018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0606__p184527505503">groups</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="iam_13_0606__p84528501500">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0606__p1045285014508">User group details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row1345225012508"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0606__p1745265012504"><a href="#iam_13_0606__table13291150195018">domain</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="iam_13_0606__p1645285075018">object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0606__p16452850175011">Domain details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row745205075015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0606__p114523504504">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="iam_13_0606__p94521050145016">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0606__p4452145012508">User ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row104521750195018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="iam_13_0606__p945215065015">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="iam_13_0606__p845211502503">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="iam_13_0606__p9452165011505">Username.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0606__table328505075012"></a><a name="table328505075012"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0606__table328505075012" frame="border" border="1" rules="all"><caption><b>Table 8 </b>IdpIdInfo</caption><thead align="left"><tr id="iam_13_0606__row19452650165015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="iam_13_0606__p445275016504">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_0606__p164521506504">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_0606__p34522503507">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0606__row12452105020509"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="iam_13_0606__p545295013505">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="iam_13_0606__p7452165035016">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="iam_13_0606__p2045285025016">Identity provider ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0606__table52881350195012"></a><a name="table52881350195012"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0606__table52881350195012" frame="border" border="1" rules="all"><caption><b>Table 9 </b>ProtocolIdInfo</caption><thead align="left"><tr id="iam_13_0606__row94525508505"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="iam_13_0606__p2452850145014">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_0606__p10452850155018">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_0606__p34521050105017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0606__row1452175017500"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="iam_13_0606__p5452150195014">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="iam_13_0606__p154521250115017">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="iam_13_0606__p74522050125013">Protocol ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="iam_13_0606__table13291150195018"></a><a name="table13291150195018"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0606__table13291150195018" frame="border" border="1" rules="all"><caption><b>Table 10 </b>DomainInfo</caption><thead align="left"><tr id="iam_13_0606__row245215025019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="iam_13_0606__p144521550205019">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_0606__p5452105012501">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_0606__p164521750195018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0606__row445275095010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="iam_13_0606__p1845215010509">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="iam_13_0606__p845265085011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="iam_13_0606__p5452205035016">Domain ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row1945255010509"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="iam_13_0606__p045265025011">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="iam_13_0606__p194524502508">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="iam_13_0606__p34520500509">Domain name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_13_0606__section1129765025015"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="iam_13_0606__screen590291217324">POST https://sample.domain.com/v3/OS-FEDERATION/identity_providers/{idp_id}/protocols/{protocol_id}/auth</pre>
|
|
</div>
|
|
<div class="section" id="iam_13_0606__section529805017508"><h4 class="sectiontitle">Example Response</h4><p id="iam_13_0606__p174521850135016"><strong id="iam_13_0606__b151351312236">Status code: 201</strong></p>
|
|
<p id="iam_13_0606__p4452205018503">The request is successful.</p>
|
|
<pre class="screen" id="iam_13_0606__screen345225055014">{
|
|
"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_0606__p1645305085011"><strong id="iam_13_0606__b1959902117231">Status code: 400</strong></p>
|
|
<p id="iam_13_0606__p15453125017503">The server failed to process the request.</p>
|
|
<pre class="screen" id="iam_13_0606__screen104531350175014">{
|
|
"error" : {
|
|
"code" : 400,
|
|
"message" : "Request parameter 'idp id' is invalid.",
|
|
"title" : "Bad Request"
|
|
}
|
|
}</pre>
|
|
<p id="iam_13_0606__p1945335018500"><strong id="iam_13_0606__b3364923112314">Status code: 401</strong></p>
|
|
<p id="iam_13_0606__p6453155018506">Authentication failed.</p>
|
|
<pre class="screen" id="iam_13_0606__screen845395016505">{
|
|
"error" : {
|
|
"code" : 401,
|
|
"message" : "The request you have made requires authentication.",
|
|
"title" : "Unauthorized"
|
|
}
|
|
}</pre>
|
|
<p id="iam_13_0606__p1545375019506"><strong id="iam_13_0606__b4973202432316">Status code: 403</strong></p>
|
|
<p id="iam_13_0606__p104534506501">Access denied.</p>
|
|
<pre class="screen" id="iam_13_0606__screen104533502508">{
|
|
"error" : {
|
|
"code" : 403,
|
|
"message" : "You are not authorized to perform the requested action.",
|
|
"title" : "Forbidden"
|
|
}
|
|
}</pre>
|
|
<p id="iam_13_0606__p245385075015"><strong id="iam_13_0606__b1040102718231">Status code: 404</strong></p>
|
|
<p id="iam_13_0606__p17453850175019">The requested resource cannot be found.</p>
|
|
<pre class="screen" id="iam_13_0606__screen1445335010509">{
|
|
"error" : {
|
|
"code" : 404,
|
|
"message" : "Could not find %(target)s: %(target_id)s.",
|
|
"title" : "Not Found"
|
|
}
|
|
}</pre>
|
|
<p id="iam_13_0606__p134531450165010"><strong id="iam_13_0606__b10145192915239">Status code: 500</strong></p>
|
|
<p id="iam_13_0606__p3453165019505">Internal system error.</p>
|
|
<pre class="screen" id="iam_13_0606__screen12453115065013">{
|
|
"error" : {
|
|
"code" : 500,
|
|
"message" : "An unexpected error prevented the server from fulfilling your request.",
|
|
"title" : "Internal Server Error"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="iam_13_0606__section7334195075015"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0606__table1833419505508" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_13_0606__row12453165013501"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="iam_13_0606__p17453250175014">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_0606__p1445315509509">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_13_0606__row18453150115013"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0606__p1745335025010">201</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0606__p1453205095018">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row124531550125020"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0606__p945315503506">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0606__p4453105055012">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row9453950145011"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0606__p3453950105017">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0606__p1745355017508">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row0453175095015"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0606__p10453195095015">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0606__p8453550135013">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row8453125045018"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0606__p8453175014502">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0606__p7453550205017">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_13_0606__row845320504503"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0606__p645310504507">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0606__p20453950145019">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>
|
|
|