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

404 lines
31 KiB
HTML
Raw Blame History

<a name="iam_02_0003"></a><a name="iam_02_0003"></a>
<h1 class="topictitle1">Obtaining an Unscoped Token (IdP Initiated)</h1>
<div id="body1520817928148"><div class="section" id="iam_02_0003__section42991548164730"><h4 class="sectiontitle">Function</h4><p id="iam_02_0003__p9619121292315">This API is used to obtain an unscoped token in IdP-initiated federated identity authentication mode.</p>
<p id="iam_02_0003__p347386339">An unscoped token cannot be used for authentication. If a federated user needs to use a token for authentication, obtain the scoped token based on section <a href="iam_13_0604.html">Obtaining a Scoped Token</a>.</p>
</div>
<div class="section" id="iam_02_0003__section999597164730"><h4 class="sectiontitle">URI</h4><p id="iam_02_0003__p4792267163236">POST /v3.0/OS-FEDERATION/tokens</p>
</div>
<div class="section" id="iam_02_0003__section30144898164730"><h4 class="sectiontitle">Request Parameters</h4><ul id="iam_02_0003__ul37385774164730"><li id="iam_02_0003__li44322980164645">Parameters in the request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__table56458564164645" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__row38321014164645"><th align="left" class="cellrowborder" valign="top" width="20.76%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="iam_02_0003__p4891467164645"><strong id="iam_02_0003__b37426530113629_1">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.299999999999997%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="iam_02_0003__p60664507164645"><strong id="iam_02_0003__b842352706112524_1">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.48%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="iam_02_0003__p14878007164645"><strong id="iam_02_0003__b84235270615026_1">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.46%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="iam_02_0003__p64267944164645"><strong id="iam_02_0003__b14438018113629_1">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__row16522014164645"><td class="cellrowborder" valign="top" width="20.76%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="iam_02_0003__p16994440164645">X-Idp-Id</p>
</td>
<td class="cellrowborder" valign="top" width="17.299999999999997%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="iam_02_0003__p34372423164645">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="iam_02_0003__p32702874164645">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="iam_02_0003__p45605165175031">ID of an identity provider.</p>
</td>
</tr>
<tr id="iam_02_0003__row27958398103142"><td class="cellrowborder" valign="top" width="20.76%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="iam_02_0003__p50037738103142">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="17.299999999999997%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="iam_02_0003__p26525003103142">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="iam_02_0003__p1041673103142">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.46%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="iam_02_0003__p61308811103259">The client must transfer the SAMLResponse parameter to the server by using the form data submitted by the browser. Therefore, the value of this parameter must be:</p>
<p id="iam_02_0003__p17266699103142">application/x-www-form-urlencoded</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="iam_02_0003__li28863801102532">Parameters in the request body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__table58447617102532" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__row28600734102532"><th align="left" class="cellrowborder" valign="top" width="20.62%" id="mcps1.3.3.2.2.1.1.5.1.1"><p id="iam_02_0003__p34958131102532"><strong id="iam_02_0003__a173ae121cc9e48328ca613e72f2a1504">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.27%" id="mcps1.3.3.2.2.1.1.5.1.2"><p id="iam_02_0003__p13036348102532"><strong id="iam_02_0003__b842352706112524_3">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.63%" id="mcps1.3.3.2.2.1.1.5.1.3"><p id="iam_02_0003__p49311266102532"><strong id="iam_02_0003__b84235270615026_3">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.480000000000004%" id="mcps1.3.3.2.2.1.1.5.1.4"><p id="iam_02_0003__p34789580102532"><strong id="iam_02_0003__b20601766145329">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__row66492578102532"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="iam_02_0003__p17189774102532">SAMLResponse</p>
</td>
<td class="cellrowborder" valign="top" width="17.27%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="iam_02_0003__p50194421102532">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="iam_02_0003__p492243151519">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.480000000000004%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="iam_02_0003__p52716491103542">Response body returned when IdP authentication is successful.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="iam_02_0003__note44922205174950"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="iam_02_0003__p4330573993853">This API can only be called on the CLI side. The client needs to obtain SAMLResponse in IdP-initiated federated identity authentication mode and obtain an unscoped token by using the form data submitted by the browser.</p>
</div></div>
</li><li id="iam_02_0003__li927648164730">Example request<pre class="screen" id="iam_02_0003__screen4121022410524">curl -i -k -H 'Accept:application/json' -H 'x-Idp-Id:test_local_idp' -H 'Content-Type:application/x-www-form-urlencoded' -X POST -d 'SAMLResponse=PD94bWwgdmVyc2lvbj0iMS4wIiBl4WXZ1OGNmYmRzWk1ZeWlLKy96anpEbm1rT2FrVVBrUmlSWEpLYUt5NzJtUmtoRFBCNjgwVQpzalU3R2hKNHE4ZG48L3hlbmM6Q2lwaGVyVmFsdWU%2BPC94ZW5jOkNpcGhlckRhdGE%2BPC94ZW5jOkVuY3J5cHRlZERhdGE%2BPC9zYW1sMjpFbmNyeXB0ZWRBc3NlcnRpb24%2BPC9zYW1sMnA6UmVzcG9uc2U%2B' https://sample.domain.com/v3.0/OS-FEDERATION/tokens</pre>
</li></ul>
</div>
<div class="section" id="iam_02_0003__section5167254164730"><h4 class="sectiontitle">Response Parameters</h4><ul id="iam_02_0003__ul48926326164730"><li id="iam_02_0003__li66778556165124">Parameters in the response header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__table30197476165124" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__row25190343165124"><th align="left" class="cellrowborder" valign="top" width="24.86%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="iam_02_0003__p63550324165124"><strong id="iam_02_0003__b84235270616223">Response Item</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.93%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="iam_02_0003__p6304564165124"><strong id="iam_02_0003__b84235270615026_5">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.21%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="iam_02_0003__p40907712165124"><strong id="iam_02_0003__b14438018113629_3">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__row31669105165124"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="iam_02_0003__p27151923165124">X-Subject-Token</p>
</td>
<td class="cellrowborder" valign="top" width="22.93%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="iam_02_0003__p36847705165124">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.21%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0026585112_p51812368">Signed unscoped token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="iam_02_0003__li12998142173817">Parameters in the response body
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__table1099820214381" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__row1299911219388"><th align="left" class="cellrowborder" valign="top" width="24.86%" id="mcps1.3.4.2.2.1.1.4.1.1"><p id="iam_02_0003__p18999152183819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.93%" id="mcps1.3.4.2.2.1.1.4.1.2"><p id="iam_02_0003__p4999172113389"><strong id="iam_02_0003__b52695021395940">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.21%" id="mcps1.3.4.2.2.1.1.4.1.3"><p id="iam_02_0003__p11999521173817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__row2999172153813"><td class="cellrowborder" valign="top" width="24.86%" headers="mcps1.3.4.2.2.1.1.4.1.1 "><p id="iam_02_0003__p8999202115388"><a href="#iam_02_0003__li15757172383815">token</a></p>
</td>
<td class="cellrowborder" valign="top" width="22.93%" headers="mcps1.3.4.2.2.1.1.4.1.2 "><p id="iam_02_0003__p139991921103813">Object</p>
</td>
<td class="cellrowborder" valign="top" width="52.21%" headers="mcps1.3.4.2.2.1.1.4.1.3 "><p id="iam_02_0003__p18999142114387">Unscoped token for federated authentication, which contains the methods and user information.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="iam_02_0003__li15757172383815"><a name="iam_02_0003__li15757172383815"></a><a name="li15757172383815"></a>token
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__en-us_topic_0224276696_response_Rs1362Token" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__en-us_topic_0224276696_row19308114312502"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.3.1.1.4.1.1"><p id="iam_02_0003__en-us_topic_0224276696_p1310164345016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.3.1.1.4.1.2"><p id="iam_02_0003__en-us_topic_0224276696_p33111443105011">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.3.1.1.4.1.3"><p id="iam_02_0003__en-us_topic_0224276696_p831218430507">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__en-us_topic_0224276696_row830884315502"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p103136430508">issued_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p1314134325017">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.3.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p173151543155019">Time when the token was issued.</p>
<div class="note" id="iam_02_0003__note74471648566"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="iam_02_0003__p18447041564">The value is a UTC time in the YYYY-MM-DDTHH:mm:ss.ssssssZ format, for example, 2023-06-28T08:56:33.710000Z. For details about the date and timestamp formats, see <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank" rel="noopener noreferrer">ISO-8601</a>.</p>
</div></div>
</td>
</tr>
<tr id="iam_02_0003__en-us_topic_0224276696_row8308943115018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p631624325013">expires_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p1031774375018">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.3.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p3318154345011">Expiration date of the token.</p>
<div class="note" id="iam_02_0003__note164861145338"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="iam_02_0003__p184862142333">The value is a UTC time in the YYYY-MM-DDTHH:mm:ss.ssssssZ format, for example, 2023-06-28T08:56:33.710000Z. For details about the date and timestamp formats, see <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank" rel="noopener noreferrer">ISO-8601</a>.</p>
</div></div>
</td>
</tr>
<tr id="iam_02_0003__en-us_topic_0224276696_row9308164316500"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p1131994319507">methods</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p1032004310509">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.3.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p1032174320507">Method for obtaining the token.</p>
</td>
</tr>
<tr id="iam_02_0003__en-us_topic_0224276696_row19308194365014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p10322124395018"><a href="#iam_02_0003__li54901824143811">user</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.3.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p3323104315015">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.3.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p11325443145016">Information about the user who requests for the token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="iam_02_0003__li54901824143811"><a name="iam_02_0003__li54901824143811"></a><a name="li54901824143811"></a>token.user
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__en-us_topic_0224276696_response_Rs1362TokenUser" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__en-us_topic_0224276696_row632611434506"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.4.1.1.4.1.1"><p id="iam_02_0003__en-us_topic_0224276696_p113281243115011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.4.1.1.4.1.2"><p id="iam_02_0003__en-us_topic_0224276696_p14329243125019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.4.1.1.4.1.3"><p id="iam_02_0003__en-us_topic_0224276696_p1733014335017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__en-us_topic_0224276696_row3326643135014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.4.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p1733194395011"><a href="#iam_02_0003__li1494814115404">domain</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.4.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p633219437506">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.4.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p6333144385016">Information about the domain to which the user belongs.</p>
</td>
</tr>
<tr id="iam_02_0003__en-us_topic_0224276696_row1332634325017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.4.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p33342433509">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.4.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p2335543165010">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.4.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p11336443105010">User ID.</p>
</td>
</tr>
<tr id="iam_02_0003__en-us_topic_0224276696_row23265434501"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.4.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p1933710435501">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.4.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p1733814430508">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.4.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p10339114317507">Username.</p>
</td>
</tr>
<tr id="iam_02_0003__en-us_topic_0224276696_row15326124316501"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.4.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p153405435506"><a href="#iam_02_0003__li094919112407">OS-FEDERATION</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.4.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p13411843145010">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.4.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p834254315017">Federated identity authentication information.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="iam_02_0003__li1494814115404"><a name="iam_02_0003__li1494814115404"></a><a name="li1494814115404"></a>token.user.domain
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__en-us_topic_0224276696_response_Rs1362TokenUserDomain" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__en-us_topic_0224276696_row334444310505"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.5.1.1.4.1.1"><p id="iam_02_0003__en-us_topic_0224276696_p4345174310504">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.5.1.1.4.1.2"><p id="iam_02_0003__en-us_topic_0224276696_p3347114385015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.5.1.1.4.1.3"><p id="iam_02_0003__en-us_topic_0224276696_p1348114335015">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__en-us_topic_0224276696_row123441143125018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p1034915438501">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p1935011431503">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.5.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p1535194385012">Domain name.</p>
</td>
</tr>
<tr id="iam_02_0003__en-us_topic_0224276696_row2344154318508"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p193531843165016">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.5.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p535414335011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.5.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p203558431509">Domain ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="iam_02_0003__li094919112407"><a name="iam_02_0003__li094919112407"></a><a name="li094919112407"></a>token.user.OS-FEDERATION
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__en-us_topic_0224276696_response_Rs1362TokenUserOsfederation" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__en-us_topic_0224276696_row535634325011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.6.1.1.4.1.1"><p id="iam_02_0003__en-us_topic_0224276696_p33571343155011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.6.1.1.4.1.2"><p id="iam_02_0003__en-us_topic_0224276696_p335824310505">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.6.1.1.4.1.3"><p id="iam_02_0003__en-us_topic_0224276696_p113591243165016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__en-us_topic_0224276696_row935684305010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.6.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p336194365014"><a href="#iam_02_0003__li1314311674010">groups</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.6.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p3362114345011">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.6.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p03634430502">User group information.</p>
</td>
</tr>
<tr id="iam_02_0003__en-us_topic_0224276696_row1435664345018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.6.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p15364194312502"><a href="#iam_02_0003__li1414416162403">identity_provider</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.6.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p53661743105019">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.6.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p336714315017">Identity provider information.</p>
</td>
</tr>
<tr id="iam_02_0003__en-us_topic_0224276696_row1635614430502"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.6.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p103681243125012"><a href="#iam_02_0003__li1892131644013">protocol</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.6.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p636910438504">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.6.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p837010432503">Protocol information.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="iam_02_0003__li1314311674010"><div class="p" id="iam_02_0003__p1776310592417"><a name="iam_02_0003__li1314311674010"></a><a name="li1314311674010"></a>token.user.OS-FEDERATION.groups
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__en-us_topic_0224276696_response_Rs1362TokenUserOsfederationGroupsArritem" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__en-us_topic_0224276696_row83711943175013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.7.1.1.1.4.1.1"><p id="iam_02_0003__en-us_topic_0224276696_p16373124325011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.7.1.1.1.4.1.2"><p id="iam_02_0003__en-us_topic_0224276696_p8374743105010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.7.1.1.1.4.1.3"><p id="iam_02_0003__en-us_topic_0224276696_p43751543195015">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__en-us_topic_0224276696_row17371164318501"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.7.1.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p16376154313504">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.7.1.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p1837710433505">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.7.1.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p19378104335020">User group ID.</p>
</td>
</tr>
<tr id="iam_02_0003__en-us_topic_0224276696_row10371443125012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.7.1.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p3379194312508">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.7.1.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p238094319503">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.7.1.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p12381164365018">User group name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</li><li id="iam_02_0003__li1414416162403"><a name="iam_02_0003__li1414416162403"></a><a name="li1414416162403"></a>token.user.OS-FEDERATION.identity_provider
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__en-us_topic_0224276696_response_Rs1362TokenUserOsfederationIdentityprovider" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__en-us_topic_0224276696_row63821243165017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.8.1.1.4.1.1"><p id="iam_02_0003__en-us_topic_0224276696_p0384144318509">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.8.1.1.4.1.2"><p id="iam_02_0003__en-us_topic_0224276696_p7385184335011">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.8.1.1.4.1.3"><p id="iam_02_0003__en-us_topic_0224276696_p123868435506">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__en-us_topic_0224276696_row83821843105011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.8.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p1038710432508">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.8.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p1388843195013">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.8.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p9389154385012">Identity provider ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="iam_02_0003__li1892131644013"><div class="p" id="iam_02_0003__p130044164216"><a name="iam_02_0003__li1892131644013"></a><a name="li1892131644013"></a>token.user.OS-FEDERATION.protocol
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__en-us_topic_0224276696_response_Rs1362TokenUserOsfederationProtocol" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__en-us_topic_0224276696_row153903436505"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.9.1.1.1.4.1.1"><p id="iam_02_0003__en-us_topic_0224276696_p16392114355017">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.9.1.1.1.4.1.2"><p id="iam_02_0003__en-us_topic_0224276696_p17393114355010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.9.1.1.1.4.1.3"><p id="iam_02_0003__en-us_topic_0224276696_p4394043125020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__en-us_topic_0224276696_row43901043125015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.9.1.1.1.4.1.1 "><p id="iam_02_0003__en-us_topic_0224276696_p2395174345010">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.9.1.1.1.4.1.2 "><p id="iam_02_0003__en-us_topic_0224276696_p339644375012">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.9.1.1.1.4.1.3 "><p id="iam_02_0003__en-us_topic_0224276696_p1339764305013">Protocol ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</li><li id="iam_02_0003__li37683757164730">Example response<pre class="screen" id="iam_02_0003__screen869816611453">{
"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": "test_local_idp"
},
"protocol": {
"id": "saml"
},
"groups": [{
"name": "admin",
"id": "45a8c8f1894444e9a016af065e152b91"
}]
},
"domain": {
"name": "hansheng",
"id": "c0e20cc993a24ad4aa3251661ef37c87"
},
"name": "FederationUser",
"id": "QNSzD0bycqUXE4hiRNfyFcWfoOs8z6gT"
}
}
}</pre>
</li></ul>
</div>
<div class="section" id="iam_02_0003__section33762092164730"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0003__table50374951164730" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0003__row57231606164730"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="iam_02_0003__p5248518164730"><strong id="iam_02_0003__b842352706104328">Status Code</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.2"><p id="iam_02_0003__p22476794164730"><strong id="iam_02_0003__b14438018113629_5">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0003__row27991504164730"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0003__p52719384164730">201</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0003__p42411696164730">The request is successful, and a token is returned.</p>
</td>
</tr>
<tr id="iam_02_0003__row64071018164730"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0003__p22370004164730">400</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0003__p31063164730">The server failed to process the request.</p>
</td>
</tr>
<tr id="iam_02_0003__row279569164730"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0003__p22645099164730">401</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0003__p22313713164730">Authentication failed.</p>
</td>
</tr>
<tr id="iam_02_0003__row66605697164730"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0003__p26352373164730">403</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0003__p54167498164730">Access denied.</p>
</td>
</tr>
<tr id="iam_02_0003__row17745440164730"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0003__p28094569164730">405</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0003__p61067622164730">The method specified in the request is not allowed for the requested resource.</p>
</td>
</tr>
<tr id="iam_02_0003__row12737692164730"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0003__p25120131164730">413</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0003__p21464722164730">The request entity is too large.</p>
</td>
</tr>
<tr id="iam_02_0003__row58964777164730"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0003__p11417608164730">500</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0003__p52411044164730">Internal server error.</p>
</td>
</tr>
<tr id="iam_02_0003__row1937348164730"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0003__p22707461164730">503</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0003__p27365047164730">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_0057845565.html">Token</a></div>
</div>
</div>
View Git Blame Copy Permalink