vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/iam/api-ref/iam_13_0208.html
Wei, Hongmin 80f18fd272 IAM API 2.6 Version 
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>
2023-08-03 03:34:59 +00:00

431 lines
30 KiB
HTML
Raw Blame History

<a name="iam_13_0208"></a><a name="iam_13_0208"></a>
<h1 class="topictitle1">Updating an OpenID Connect Identity Provider</h1>
<div id="body1598526655526"><div class="section" id="iam_13_0208__section8465839203813"><h4 class="sectiontitle">Function</h4><p id="iam_13_0208__p86171839183816">This API is provided for the administrator to modify an OpenID Connect identity provider.</p>
</div>
<div class="section" id="iam_13_0208__section54671939193820"><h4 class="sectiontitle">URI</h4><p id="iam_13_0208__p36171339133820">PUT /v3.0/OS-FEDERATION/identity-providers/{idp_id}/openid-connect-config</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0208__table20468123903812" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="iam_13_0208__row4617133913819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="iam_13_0208__p136172391386">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_0208__p1061783913380">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_0208__p1361718392380">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_0208__p96171239193812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_13_0208__row261793993815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="iam_13_0208__p18617439133813">idp_id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.5.1.2 "><p id="iam_13_0208__p861713918382">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="iam_13_0208__p1761719395389">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.5.1.4 "><p id="iam_13_0208__p1161793911385">Identity provider ID.</p>
<p id="iam_13_0208__p276416271028">Length: 1 to 64 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_13_0208__section1047314394387"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0208__table947416399386" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="iam_13_0208__row16617839123820"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="iam_13_0208__p186171039193819">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_0208__p56179398382">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_0208__p1561716395387">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_0208__p15617539123815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_13_0208__row14617183953814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_13_0208__p1761743916387">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_13_0208__p4617339143813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_13_0208__p9617143914388">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_13_0208__p10617143914384">Fill <strong id="iam_13_0208__b310562421113">application/json;charset=utf8</strong> in this field.</p>
</td>
</tr>
<tr id="iam_13_0208__row17617163903810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="iam_13_0208__p961793918386">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.2.2.5.1.2 "><p id="iam_13_0208__p6617439183812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="iam_13_0208__p8617103916385">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.5.1.4 "><p id="iam_13_0208__p12617113918388">Token with <strong id="iam_13_0208__b246935375818">Security Administrator</strong> permissions.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0208__table164791339133814" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request body</caption><thead align="left"><tr id="iam_13_0208__row16617153973813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="iam_13_0208__p13617143910382">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_0208__p146171639133819">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_0208__p1661712394387">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_0208__p1617039163814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_13_0208__row061793933817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="iam_13_0208__p96171839153815"><a href="#iam_13_0208__table1648243993811">openid_connect_config</a></p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="iam_13_0208__p3617839163820">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="iam_13_0208__p17617163913812">object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="iam_13_0208__p66172397381">OpenID Connect configurations.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_13_0208__table1648243993811"></a><a name="table1648243993811"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0208__table1648243993811" frame="border" border="1" rules="all"><caption><b>Table 4 </b>openid_connect_config</caption><thead align="left"><tr id="iam_13_0208__row15617139103812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="iam_13_0208__p161753943817">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_0208__p11617639193818">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_0208__p17617039173816">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_0208__p96171839163812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_13_0208__row161710393388"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_13_0208__p861773953817">access_mode</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_13_0208__p106171539193811">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_13_0208__p861712394388">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_13_0208__p611593517328">Access type. Options:</p>
<ul id="iam_13_0208__ul1166237163218"><li id="iam_13_0208__li8682123913328"><strong id="iam_13_0208__b1922193651113">program_console</strong>: programmatic access and management console access.</li><li id="iam_13_0208__li14166837203213"><strong id="iam_13_0208__b990933681114">program</strong>: programmatic access only.</li></ul>
</td>
</tr>
<tr id="iam_13_0208__row10617133983819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_13_0208__p16617539143815">idp_url</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_13_0208__p861773918381">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_13_0208__p15617183916386">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_13_0208__p1514462119318">URL of the OpenID Connect identity provider. This field corresponds to the <strong id="iam_13_0208__b102341839121114">iss</strong> field in the ID token.</p>
<p id="iam_13_0208__p413564920525">Length: 10 to 255 characters</p>
</td>
</tr>
<tr id="iam_13_0208__row7617839103817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_13_0208__p86172397381">client_id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_13_0208__p161713393383">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_13_0208__p66181239113814">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_13_0208__p111454219316">ID of a client registered with the OpenID Connect identity provider.</p>
<p id="iam_13_0208__p34251044175219">Length: 5 to 255 characters</p>
</td>
</tr>
<tr id="iam_13_0208__row136189392388"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_13_0208__p5618123911381">authorization_endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_13_0208__p2618133913389">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_13_0208__p3618173917388">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_13_0208__p1427416283317">Authorization endpoint of the OpenID Connect identity provider.</p>
<p id="iam_13_0208__p714514217312">This field is required only if <strong id="iam_13_0208__b123692518124">access_mode</strong> is set to <strong id="iam_13_0208__b1937620541214">program_console</strong>.</p>
<p id="iam_13_0208__p1851121112535">Length: 10 to 255 characters</p>
</td>
</tr>
<tr id="iam_13_0208__row861813903810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_13_0208__p16618339193813">scope</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_13_0208__p11618173903819">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_13_0208__p261823963817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_13_0208__p1460272123315">Scope of authorization requests.</p>
<p id="iam_13_0208__p217382453312">This field is required only if <strong id="iam_13_0208__b56226104124">access_mode</strong> is set to <strong id="iam_13_0208__b20627610101215">program_console</strong>.</p>
<p id="iam_13_0208__p137881118173510">Enumerated values:</p>
<ul id="iam_13_0208__ul182672313510"><li id="iam_13_0208__li4262237352">openid</li><li id="iam_13_0208__li1526723103517">email</li><li id="iam_13_0208__li12662315356">profile<div class="note" id="iam_13_0208__note78171434125310"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="iam_13_0208__ul940272714014"><li id="iam_13_0208__li174622917012"><strong id="iam_13_0208__b526919131122">openid</strong> must be specified for this field.</li><li id="iam_13_0208__li94021271108">You can specify 1 to 10 values and separate them with spaces.</li></ul>
<p id="iam_13_0208__p457525410018">Example: <strong id="iam_13_0208__b3338161516126">openid</strong>, <strong id="iam_13_0208__b1133817158129">openid email</strong>, <strong id="iam_13_0208__b333921581218">openid profile</strong>, and <strong id="iam_13_0208__b233971591217">openid email profile</strong>.</p>
</div></div>
</li></ul>
</td>
</tr>
<tr id="iam_13_0208__row761814395384"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_13_0208__p9618133913383">response_type</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_13_0208__p166181439113813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_13_0208__p1861893911384">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_13_0208__p1841811576348">Response type.</p>
<p id="iam_13_0208__p15291049103419">This field is required only if <strong id="iam_13_0208__b10402121714121">access_mode</strong> is set to <strong id="iam_13_0208__b1840221701218">program_console</strong>.</p>
<p id="iam_13_0208__p3145192183119">Enumerated value:</p>
<ul id="iam_13_0208__ul71451221133119"><li id="iam_13_0208__li9145152116319">id_token</li></ul>
</td>
</tr>
<tr id="iam_13_0208__row20618173918386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_13_0208__p561883918385">response_mode</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_13_0208__p2618133923813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_13_0208__p8618193915383">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_13_0208__p1155410285350">Response mode.</p>
<p id="iam_13_0208__p914520214311">This field is required only if <strong id="iam_13_0208__b148591922101214">access_mode</strong> is set to <strong id="iam_13_0208__b086417228122">program_console</strong>.</p>
<p id="iam_13_0208__p01451621113115">Enumerated values:</p>
<ul id="iam_13_0208__ul914502123116"><li id="iam_13_0208__li101452212315">fragment</li><li id="iam_13_0208__li1014502110317">form_post</li></ul>
</td>
</tr>
<tr id="iam_13_0208__row36183395382"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="iam_13_0208__p1761843913387">signing_key</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.4.2.5.1.2 "><p id="iam_13_0208__p1361814391381">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="iam_13_0208__p166181839183818">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.4.2.5.1.4 "><p id="iam_13_0208__p414552115316">Public key used to sign the ID token of the OpenID Connect identity provider.</p>
<p id="iam_13_0208__p14891429613">Length: 10 to 30,000 characters</p>
<p id="iam_13_0208__p1217527174916">Format example:</p>
<pre class="screen" id="iam_13_0208__screen152894895118">{
"keys":[
{
"kid":"d05ef20c4512645vv1..." ,
"n":"cws_cnjiwsbvweolwn_-vnl...",
"e":"AQAB",
"kty":"RSA",
"use":"sig",
"alg":"RS256"
}
]
} </pre>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_13_0208__section14497193983812"><h4 class="sectiontitle">Response Parameters</h4><p id="iam_13_0208__p196184397388"><strong id="iam_13_0208__b193371636111212">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0208__table24971039143812" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameters in the response body</caption><thead align="left"><tr id="iam_13_0208__row36186398382"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="iam_13_0208__p19618039123811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="iam_13_0208__p561813910381">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="iam_13_0208__p1061843933819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_13_0208__row1361823973812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="iam_13_0208__p5618113914388"><a href="#iam_13_0208__table1750018395381">openid_connect_config</a></p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="iam_13_0208__p7618113973812">object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="iam_13_0208__p46181397386">OpenID Connect configurations.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="iam_13_0208__table1750018395381"></a><a name="table1750018395381"></a><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0208__table1750018395381" frame="border" border="1" rules="all"><caption><b>Table 6 </b>OpenIDConnectConfig</caption><thead align="left"><tr id="iam_13_0208__row1261813943813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="iam_13_0208__p10618539123818">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_0208__p1261853917386">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_0208__p1761833973812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_13_0208__row166181139113818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_13_0208__p061843983814">access_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_13_0208__p19618839183816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_13_0208__p17142161417">Access type. Options:</p>
<ul id="iam_13_0208__ul1471112181411"><li id="iam_13_0208__li207117210142"><strong id="iam_13_0208__b16562154220126">program_console</strong>: programmatic access and management console access.</li><li id="iam_13_0208__li871421142"><strong id="iam_13_0208__b1097215426127">program</strong>: programmatic access only.</li></ul>
</td>
</tr>
<tr id="iam_13_0208__row661819395389"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_13_0208__p9618173913384">idp_url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_13_0208__p2061833919389">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_13_0208__p3719216143">URL of the OpenID Connect identity provider. This field corresponds to the <strong id="iam_13_0208__b1275614351212">iss</strong> field in the ID token.</p>
<p id="iam_13_0208__p4717251411">Length: 10 to 255 characters</p>
</td>
</tr>
<tr id="iam_13_0208__row196186394389"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_13_0208__p11618153915387">client_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_13_0208__p176181239173813">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_13_0208__p17711522141">ID of a client registered with the OpenID Connect identity provider.</p>
<p id="iam_13_0208__p771112141412">Length: 5 to 255 characters</p>
</td>
</tr>
<tr id="iam_13_0208__row9618539103811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_13_0208__p861873916380">authorization_endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_13_0208__p1861863912382">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_13_0208__p10713217147">Authorization endpoint of the OpenID Connect identity provider.</p>
<p id="iam_13_0208__p6712021148">This field is required only if <strong id="iam_13_0208__b1614924951218">access_mode</strong> is set to <strong id="iam_13_0208__b615454918121">program_console</strong>.</p>
<p id="iam_13_0208__p107110216149">Length: 10 to 255 characters</p>
</td>
</tr>
<tr id="iam_13_0208__row76189397381"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_13_0208__p14618123933812">scope</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_13_0208__p196181939163818">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_13_0208__p197115231419">Scope of authorization requests.</p>
<p id="iam_13_0208__p57114201413">This field is required only if <strong id="iam_13_0208__b6689145117127">access_mode</strong> is set to <strong id="iam_13_0208__b36905515127">program_console</strong>.</p>
<p id="iam_13_0208__p137113291412">Enumerated values:</p>
<ul id="iam_13_0208__ul12715216144"><li id="iam_13_0208__li67115220140">openid</li><li id="iam_13_0208__li67142201420">email</li><li id="iam_13_0208__li1971122141412">profile<div class="note" id="iam_13_0208__note4711628144"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="iam_13_0208__ul37114218149"><li id="iam_13_0208__li107102171413"><strong id="iam_13_0208__b057114553124">openid</strong> must be specified for this field.</li><li id="iam_13_0208__li57118218149">You can specify 1 to 10 values and separate them with spaces.</li></ul>
<p id="iam_13_0208__p177119221413">Example: <strong id="iam_13_0208__b183195570124">openid</strong>, <strong id="iam_13_0208__b1432055717122">openid email</strong>, <strong id="iam_13_0208__b19320195714123">openid profile</strong>, and <strong id="iam_13_0208__b13205577123">openid email profile</strong>.</p>
</div></div>
</li></ul>
</td>
</tr>
<tr id="iam_13_0208__row56181039183814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_13_0208__p7618173919382">response_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_13_0208__p1461813923811">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_13_0208__p187132131416">Response type.</p>
<p id="iam_13_0208__p3713217141">This field is required only if <strong id="iam_13_0208__b1174165812128">access_mode</strong> is set to <strong id="iam_13_0208__b117405881210">program_console</strong>.</p>
<p id="iam_13_0208__p9711124141">Enumerated value:</p>
<ul id="iam_13_0208__ul57152121418"><li id="iam_13_0208__li971728145">id_token</li></ul>
</td>
</tr>
<tr id="iam_13_0208__row11619183912380"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_13_0208__p5619939203813">response_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_13_0208__p166193391388">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_13_0208__p107192151419">Response mode.</p>
<p id="iam_13_0208__p77172101410">This field is required only if <strong id="iam_13_0208__b3517391320">access_mode</strong> is set to <strong id="iam_13_0208__b15571735137">program_console</strong>.</p>
<p id="iam_13_0208__p1671425147">Enumerated values:</p>
<ul id="iam_13_0208__ul12713261419"><li id="iam_13_0208__li4713231411">fragment</li><li id="iam_13_0208__li77142111411">form_post</li></ul>
</td>
</tr>
<tr id="iam_13_0208__row96191839203816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="iam_13_0208__p1161913912382">signing_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="iam_13_0208__p20619639143817">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="iam_13_0208__p37210241417">Public key used to sign the ID token of the OpenID Connect identity provider.</p>
<p id="iam_13_0208__p2727211416">Length: 10 to 30,000 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="iam_13_0208__section7511133963810"><h4 class="sectiontitle">Example Request</h4><ul id="iam_13_0208__ul46191139133816"><li id="iam_13_0208__li961918392389">Modifying an identity provider that supports programmatic access<pre class="screen" id="iam_13_0208__screen18373711104114">PUT /v3.0/OS-FEDERATION/identity-providers/{idp_id}/openid-connect-config
{
"openid_connect_config" : {
"access_mode" : "program",
"idp_url" : "https://accounts.example.com",
"client_id" : "client_id_example",
"signing_key" : "{\"keys\":[{\"kty\":\"RSA\",\"e\":\"AQAB\",\"use\":\"sig\",\"n\":\"example\",\"kid\":\"kid_example\",\"alg\":\"RS256\"}]}"
}
}</pre>
</li><li id="iam_13_0208__li2619153993811">Modifying an identity provider that supports programmatic access and management console access<pre class="screen" id="iam_13_0208__screen2659141644115">PUT /v3.0/OS-FEDERATION/identity-providers/{idp_id}/openid-connect-config
{
"openid_connect_config" : {
"access_mode" : "program_console",
"idp_url" : "https://accounts.example.com",
"client_id" : "client_id_example",
"authorization_endpoint" : "https://accounts.example.com/o/oauth2/v2/auth",
"scope" : "openid",
"response_type" : "id_token",
"response_mode" : "form_post",
"signing_key" : "{\"keys\":[{\"kty\":\"RSA\",\"e\":\"AQAB\",\"use\":\"sig\",\"n\":\"example\",\"kid\":\"kid_example\",\"alg\":\"RS256\"}]}"
}
}</pre>
</li></ul>
</div>
<div class="section" id="iam_13_0208__section1151363912381"><h4 class="sectiontitle">Example Response</h4><p id="iam_13_0208__p1961912399388"><strong id="iam_13_0208__b426114438138">Status code: 200</strong></p>
<div class="p" id="iam_13_0208__p1461920393389">The request is successful.<pre class="screen" id="iam_13_0208__screen15619163915381">{
"openid_connect_config" : {
"access_mode" : "program_console",
"idp_url" : "https://accounts.example.com",
"client_id" : "client_id_example",
"authorization_endpoint" : "https://accounts.example.com/o/oauth2/v2/auth",
"scope" : "openid",
"response_type" : "id_token",
"response_mode" : "form_post",
"signing_key" : "{\"keys\":[{\"kty\":\"RSA\",\"e\":\"AQAB\",\"use\":\"sig\",\"n\":\"example\",\"kid\":\"kid_example\",\"alg\":\"RS256\"}]}"
}
}</pre>
</div>
<p id="iam_13_0208__p461923912384"><strong id="iam_13_0208__b434924610133">Status code: 400</strong></p>
<p id="iam_13_0208__p96193391384">The server failed to process the request.</p>
<pre class="screen" id="iam_13_0208__screen8619103973818">{
"error_msg" : "Request body is invalid.",
"error_code" : "IAM.0011"
}</pre>
<p id="iam_13_0208__p361912399388"><strong id="iam_13_0208__b0957447181313">Status code: 401</strong></p>
<p id="iam_13_0208__p7619133911384">Authentication failed.</p>
<pre class="screen" id="iam_13_0208__screen7619143913387">{
"error_msg" : "The request you have made requires authentication.",
"error_code" : "IAM.0001"
}</pre>
<p id="iam_13_0208__p9619203919386"><strong id="iam_13_0208__b44699497134">Status code: 403</strong></p>
<p id="iam_13_0208__p4619163918381">Access denied.</p>
<pre class="screen" id="iam_13_0208__screen19619939193815">{
"error_msg" : "Policy doesn't allow %(actions)s to be performed.",
"error_code" : "IAM.0003"
}</pre>
<p id="iam_13_0208__p20619193923811"><strong id="iam_13_0208__b12202115291316">Status code: 404</strong></p>
<p id="iam_13_0208__p15619173911386">The requested resource cannot be found.</p>
<pre class="screen" id="iam_13_0208__screen15619113973810">{
"error_msg" : "Could not find %(target)s: %(target_id)s.",
"error_code" : "IAM.0004"
}</pre>
<p id="iam_13_0208__p1661993915381"><strong id="iam_13_0208__b12366155551318">Status code: 500</strong></p>
<p id="iam_13_0208__p56191739173818">Internal server error.</p>
<pre class="screen" id="iam_13_0208__screen16619339173810">{
"error_msg" : "An unexpected error prevented the server from fulfilling your request.",
"error_code" : "IAM.0006"
}</pre>
</div>
<div class="section" id="iam_13_0208__section951873923814"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_13_0208__table3518339193818" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_13_0208__row461903916384"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="iam_13_0208__p8619143917382">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_0208__p86199393382">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_13_0208__row19619173910382"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0208__p116191539143815">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0208__p1961963918382">The request is successful.</p>
</td>
</tr>
<tr id="iam_13_0208__row66191239143811"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0208__p12619133918386">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0208__p361943953818">The server failed to process the request.</p>
</td>
</tr>
<tr id="iam_13_0208__row1361910397384"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0208__p46191739133817">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0208__p166192039123815">Authentication failed.</p>
</td>
</tr>
<tr id="iam_13_0208__row9619143911381"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0208__p76195391380">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0208__p136192039103815">Access denied.</p>
</td>
</tr>
<tr id="iam_13_0208__row561973914387"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0208__p19620133913384">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0208__p15620163933812">The requested resource cannot be found.</p>
</td>
</tr>
<tr id="iam_13_0208__row196203392387"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="iam_13_0208__p13620153943810">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="iam_13_0208__p15620939203813">Internal server 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_0057845605.html">Identity Provider</a></div>
</div>
</div>
View Git Blame Copy Permalink