forked from docs/doc-exports
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
647 lines
48 KiB
HTML
647 lines
48 KiB
HTML
<a name="CreateCustomAuthorizerV2_1"></a><a name="CreateCustomAuthorizerV2_1"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Custom Authorizer</h1>
|
|
<div id="body12630121014377"><div class="section" id="CreateCustomAuthorizerV2_1__section11630181053716"><h4 class="sectiontitle">Function</h4><p id="CreateCustomAuthorizerV2_1__p963121015377">This API is used to create a custom authorizer.</p>
|
|
</div>
|
|
<div class="section" id="CreateCustomAuthorizerV2_1__atuogenerate_2"><h4 class="sectiontitle">URI</h4><p id="CreateCustomAuthorizerV2_1__p15632110153715">POST /v2/{project_id}/apigw/instances/{instance_id}/authorizers</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__table1963591023713" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row963411020372"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateCustomAuthorizerV2_1__p10635151010372">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateCustomAuthorizerV2_1__p4636510143719">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateCustomAuthorizerV2_1__p2636121043720">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateCustomAuthorizerV2_1__p13636710173710">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row763431013378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p17637210143712">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p36382010153711">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p9638210163717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p126391810133710">Project ID. For details about how to obtain it, see <a href="apig-api-180713009.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row18634151010374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p46391610143712">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p864014106371">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p1464041017374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p864121013713">Gateway ID, which can be obtained from the gateway information on the APIG console.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateCustomAuthorizerV2_1__section664181016376"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row17642201018373"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateCustomAuthorizerV2_1__p116433106379">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="CreateCustomAuthorizerV2_1__p8644410163711">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="CreateCustomAuthorizerV2_1__p964451011379">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="CreateCustomAuthorizerV2_1__p1364591011371">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row1964271017375"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p364513108375">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p136465107375">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p16646121010377">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p176476108375">User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__request_AuthorizerCreate" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row13648410173713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateCustomAuthorizerV2_1__p17651111023710">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateCustomAuthorizerV2_1__p166511510153718">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateCustomAuthorizerV2_1__p1565215105376">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateCustomAuthorizerV2_1__p1365291003718">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row964816108374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p66535104370">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p46536107377">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p17653151043719">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p26542104378">Custom authorizer name.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p116541010203715">It can contain 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row2064881063713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p66555104378">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p665561043717">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p146551810113716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p16656111003711">Custom authorizer type.</p>
|
|
<ul id="CreateCustomAuthorizerV2_1__ul1965691014376"><li id="CreateCustomAuthorizerV2_1__li5656710123719">FRONTEND</li><li id="CreateCustomAuthorizerV2_1__li1765711013719">BACKEND</li></ul>
|
|
<p id="CreateCustomAuthorizerV2_1__p1265781013713">Modification is not allowed.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p865811106373">Enumeration values:</p>
|
|
<ul id="CreateCustomAuthorizerV2_1__ul136585103379"><li id="CreateCustomAuthorizerV2_1__li86581810163711"><strong id="CreateCustomAuthorizerV2_1__b765831013720">FRONTEND</strong></li><li id="CreateCustomAuthorizerV2_1__li56589102375"><strong id="CreateCustomAuthorizerV2_1__b6659131063715">BACKEND</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row5648201017378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p1565921016378">authorizer_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p065914100372">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p866017105372">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p4660110113717">Value: FUNC.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p266114109376">Enumeration values:</p>
|
|
<ul id="CreateCustomAuthorizerV2_1__ul186612101375"><li id="CreateCustomAuthorizerV2_1__li366161010373"><strong id="CreateCustomAuthorizerV2_1__b1666181073717">FUNC</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row146483102374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p1366181073711">authorizer_uri</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p1066216108378">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p136621104376">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p1566331023717">Function URN.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row116490108377"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p3668910143713">authorizer_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p17668310113715">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p1666961012379">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p466912107377">Function version.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p3669111073720">If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p667011102376">Maximum: <strong id="CreateCustomAuthorizerV2_1__b2670161033716">64</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row14649610113713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p4670610173718">authorizer_alias_uri</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p667110103371">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p15671810143714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p17672151053719">Function alias URN.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p15672910143719">If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row564991014378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p1067271063715">identities</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p18673151073717">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p967310103372">Array of <a href="#CreateCustomAuthorizerV2_1__request_Identity">Identity</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p767410102376">Identity source.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row1764911083715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p46741610193719">ttl</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p13675141053714">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p206751510143720">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p0675110173710">Maximum cache age.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row14649141033718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p11676121020379">user_data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p10676810103719">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p46776101378">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p067711043713">User data.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row86491010153720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p767831010372">ld_api_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p18678191011375">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p1567817109371">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p176811110153710">Custom backend ID.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p668120102372">Currently, this parameter is not supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row36496102378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p156826102374">need_body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p36820103376">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p1668361013710">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p2683191017370">Indicates whether to send the body.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="CreateCustomAuthorizerV2_1__request_Identity"></a><a name="request_Identity"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__request_Identity" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Identity</caption><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row56841210173711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="CreateCustomAuthorizerV2_1__p36861510163717">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="CreateCustomAuthorizerV2_1__p11686101019374">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="CreateCustomAuthorizerV2_1__p1168612105372">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="CreateCustomAuthorizerV2_1__p1868771019371">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row1168431023719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p66871101377">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p1568811106375">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p1368816100378">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p20689910113718">Parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row96847101376"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p868917106372">location</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p6690161019371">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p176901510193715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p106900107376">Parameter location.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p369161012379">Enumeration values:</p>
|
|
<ul id="CreateCustomAuthorizerV2_1__ul3691610173715"><li id="CreateCustomAuthorizerV2_1__li1869131011379"><strong id="CreateCustomAuthorizerV2_1__b1469119107377">HEADER</strong></li><li id="CreateCustomAuthorizerV2_1__li86921210143715"><strong id="CreateCustomAuthorizerV2_1__b66921510153714">QUERY</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row1568511093713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateCustomAuthorizerV2_1__p206926107379">validation</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateCustomAuthorizerV2_1__p166931910113713">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateCustomAuthorizerV2_1__p56931109378">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateCustomAuthorizerV2_1__p18693111013371">Parameter verification expression. The default value is null, indicating that no verification is performed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateCustomAuthorizerV2_1__section14694110193719"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateCustomAuthorizerV2_1__p2695101016372"><strong id="CreateCustomAuthorizerV2_1__b18695131019377">Status code: 201</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__response_AuthorizerResp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row769601018377"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateCustomAuthorizerV2_1__p166985107374">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateCustomAuthorizerV2_1__p8699010163716">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateCustomAuthorizerV2_1__p15700101033714">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row106966101371"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p147001810113716">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p1070181016373">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p16702191053720">Custom authorizer name.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p18702110133716">It can contain 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row196967101377"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p1970201053716">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p370311107378">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p67041910173713">Custom authorizer type.</p>
|
|
<ul id="CreateCustomAuthorizerV2_1__ul270441073719"><li id="CreateCustomAuthorizerV2_1__li17704191043712">FRONTEND</li><li id="CreateCustomAuthorizerV2_1__li17051610173714">BACKEND</li></ul>
|
|
<p id="CreateCustomAuthorizerV2_1__p77059103375">Modification is not allowed.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p3706410173717">Enumeration values:</p>
|
|
<ul id="CreateCustomAuthorizerV2_1__ul070651023715"><li id="CreateCustomAuthorizerV2_1__li4706910173712"><strong id="CreateCustomAuthorizerV2_1__b1670611013711">FRONTEND</strong></li><li id="CreateCustomAuthorizerV2_1__li18707181083714"><strong id="CreateCustomAuthorizerV2_1__b2707111033714">BACKEND</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row069601053712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p1570711013711">authorizer_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p147082106374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p6709210183717">Value: FUNC.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p37091610173716">Enumeration values:</p>
|
|
<ul id="CreateCustomAuthorizerV2_1__ul107091910193711"><li id="CreateCustomAuthorizerV2_1__li157092103371"><strong id="CreateCustomAuthorizerV2_1__b11710510173719">FUNC</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row36961310203717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p87101710193715">authorizer_uri</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p77101310163720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p771141033718">Function URN.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row196971910123711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p0715191043715">authorizer_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p1871561013713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p177161710153710">Function version.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p11716101016371">If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p17171110183720">Maximum: <strong id="CreateCustomAuthorizerV2_1__b7717171053720">64</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row13697191093711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p1371716103379">authorizer_alias_uri</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p137176107379">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p571819105373">Function alias URN.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p971818101378">If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row7697131083716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p197191810123710">identities</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p147195105374">Array of <a href="#CreateCustomAuthorizerV2_1__response_Identity">Identity</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p19720510163717">Identity source.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row10697141033718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p14720610173717">ttl</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p12720610133717">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p572131033717">Maximum cache age.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row7697111014378"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p17221210163714">user_data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p07226108371">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p97231210173710">User data.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row12697810133710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p1472313103379">ld_api_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p67237105372">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p177242107376">Custom backend ID.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p67241110163710">Currently, this parameter is not supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row76971210193715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p18725310163719">need_body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p47251101373">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p7725610143718">Indicates whether to send the body.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row06971010163712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p177261110163716">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p18726110183712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p16727191053720">Custom authorizer ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row146971106373"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p167271710123713">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p107271110123711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p17728210163716">Creation time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row669731013379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p1872810107375">roma_app_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p1873118105376">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p2073161017378">ID of the application to which the custom authorizer belongs.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p27321410153718">Currently, this parameter is not supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row196971410193720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p177321710183711">roma_app_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p1673341010374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p2154912103712">Name of the application to which the custom authorizer belongs.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p19155191283719">Currently, this parameter is not supported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="CreateCustomAuthorizerV2_1__response_Identity"></a><a name="response_Identity"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__response_Identity" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Identity</caption><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row473510107374"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="CreateCustomAuthorizerV2_1__p81551812203720">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="CreateCustomAuthorizerV2_1__p101556124371">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="CreateCustomAuthorizerV2_1__p1115661253712">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row15735910153716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p1715681210374">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p31561412103716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p171564129375">Parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row18735510163712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p2156121213379">location</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p31569125372">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p31567129379">Parameter location.</p>
|
|
<p id="CreateCustomAuthorizerV2_1__p12156312183715">Enumeration values:</p>
|
|
<ul id="CreateCustomAuthorizerV2_1__ul315711273711"><li id="CreateCustomAuthorizerV2_1__li1015741217376"><strong id="CreateCustomAuthorizerV2_1__b5157171273717">HEADER</strong></li><li id="CreateCustomAuthorizerV2_1__li151571612163713"><strong id="CreateCustomAuthorizerV2_1__b121577128372">QUERY</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row1373561011374"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p1815701213373">validation</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p815781283719">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p19157121283719">Parameter verification expression. The default value is null, indicating that no verification is performed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateCustomAuthorizerV2_1__p815821220375"><strong id="CreateCustomAuthorizerV2_1__b111581312143713">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__response_ErrorMsg" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row674021012377"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="CreateCustomAuthorizerV2_1__p815821253712">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="CreateCustomAuthorizerV2_1__p1215841263710">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="CreateCustomAuthorizerV2_1__p2015861210373">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row1174051015375"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p2158612183712">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p2158812143720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p715912120372">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row07402010153718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p11599128372">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p715915122374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p1915951243710">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateCustomAuthorizerV2_1__p1915911126372"><strong id="CreateCustomAuthorizerV2_1__b11591512183717">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__response_ErrorMsg_1" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row274511018376"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="CreateCustomAuthorizerV2_1__p10159171212375">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="CreateCustomAuthorizerV2_1__p5160191212375">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="CreateCustomAuthorizerV2_1__p3160312163712">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row874591033719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p1116012128378">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p1716021273717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p161601412203714">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row1774517107375"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p181601412123715">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p6160112103712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p216181243713">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateCustomAuthorizerV2_1__p5161181219377"><strong id="CreateCustomAuthorizerV2_1__b11161111211377">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__response_ErrorMsg_2" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row4749141003711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="CreateCustomAuthorizerV2_1__p716114124373">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p id="CreateCustomAuthorizerV2_1__p19161171216373">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p id="CreateCustomAuthorizerV2_1__p191616129378">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row3749141017379"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p17161171213374">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p191621612123717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p181621012113717">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row19749510203715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p116221214372">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p1916201213714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p51621612183710">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateCustomAuthorizerV2_1__p5162181243717"><strong id="CreateCustomAuthorizerV2_1__b101625129372">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__response_ErrorMsg_3" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row47531110123711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.1"><p id="CreateCustomAuthorizerV2_1__p11631712173711">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.2"><p id="CreateCustomAuthorizerV2_1__p11634122373">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.12.2.4.1.3"><p id="CreateCustomAuthorizerV2_1__p916319127378">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row197531710153715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p1516311217379">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p41631125373">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p1316431217374">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row14753141073711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p18164171273720">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p81641712173711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p15164712133712">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateCustomAuthorizerV2_1__p101648128371"><strong id="CreateCustomAuthorizerV2_1__b41649125377">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__response_ErrorMsg_4" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row075621020377"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.1"><p id="CreateCustomAuthorizerV2_1__p141651412143717">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.2"><p id="CreateCustomAuthorizerV2_1__p1216591223713">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.14.2.4.1.3"><p id="CreateCustomAuthorizerV2_1__p1616501293710">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row2757110183714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p316551211370">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p416511126379">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p916518129377">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row275751013711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="CreateCustomAuthorizerV2_1__p131656120378">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="CreateCustomAuthorizerV2_1__p19166131219371">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="CreateCustomAuthorizerV2_1__p1616611253714">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateCustomAuthorizerV2_1__section616631203717"><h4 class="sectiontitle">Example Requests</h4><p id="CreateCustomAuthorizerV2_1__p416691211371">Creating a frontend custom authorizer</p>
|
|
<pre class="screen" id="CreateCustomAuthorizerV2_1__screen1716641263710">{
|
|
"name" : "Authorizer_demo",
|
|
"type" : "FRONTEND",
|
|
"authorizer_type" : "FUNC",
|
|
"authorizer_uri" : "urn:fss:xx-xxx:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
|
|
"authorizer_version" : "v1",
|
|
"authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
|
|
"identities" : [ {
|
|
"name" : "header",
|
|
"location" : "HEADER"
|
|
} ],
|
|
"user_data" : "authorizer_test"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="CreateCustomAuthorizerV2_1__section416841210374"><h4 class="sectiontitle">Example Responses</h4><p id="CreateCustomAuthorizerV2_1__p171681912113713"><strong id="CreateCustomAuthorizerV2_1__b1716815128374">Status code: 201</strong></p>
|
|
<p id="CreateCustomAuthorizerV2_1__p6168412123715">Created</p>
|
|
<pre class="screen" id="CreateCustomAuthorizerV2_1__screen8168111263720">{
|
|
"name" : "Authorizer_demo",
|
|
"type" : "FRONTEND",
|
|
"authorizer_type" : "FUNC",
|
|
"authorizer_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
|
|
"authorizer_version" : "v1",
|
|
"authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
|
|
"identities" : [ {
|
|
"name" : "header",
|
|
"location" : "HEADER"
|
|
} ],
|
|
"ttl" : 0,
|
|
"user_data" : "authorizer_test",
|
|
"id" : "0d982c1ac3da493dae47627b6439fc5c",
|
|
"create_time" : "2020-07-31T11:55:43Z"
|
|
}</pre>
|
|
<p id="CreateCustomAuthorizerV2_1__p1170121253711"><strong id="CreateCustomAuthorizerV2_1__b18170912123720">Status code: 400</strong></p>
|
|
<p id="CreateCustomAuthorizerV2_1__p717013121373">Bad Request</p>
|
|
<pre class="screen" id="CreateCustomAuthorizerV2_1__screen17171181263711">{
|
|
"error_code" : "APIG.2011",
|
|
"error_msg" : "Invalid parameter value,parameterName:type. Please refer to the support documentation"
|
|
}</pre>
|
|
<p id="CreateCustomAuthorizerV2_1__p1317116122372"><strong id="CreateCustomAuthorizerV2_1__b11711512193713">Status code: 401</strong></p>
|
|
<p id="CreateCustomAuthorizerV2_1__p517131243720">Unauthorized</p>
|
|
<pre class="screen" id="CreateCustomAuthorizerV2_1__screen14171181214372">{
|
|
"error_code" : "APIG.1002",
|
|
"error_msg" : "Incorrect token or token resolution failed"
|
|
}</pre>
|
|
<p id="CreateCustomAuthorizerV2_1__p17172181212377"><strong id="CreateCustomAuthorizerV2_1__b11172161203719">Status code: 403</strong></p>
|
|
<p id="CreateCustomAuthorizerV2_1__p6172171214372">Forbidden</p>
|
|
<pre class="screen" id="CreateCustomAuthorizerV2_1__screen217231233715">{
|
|
"error_code" : "APIG.1005",
|
|
"error_msg" : "No permissions to request this method"
|
|
}</pre>
|
|
<p id="CreateCustomAuthorizerV2_1__p0173412153717"><strong id="CreateCustomAuthorizerV2_1__b217316126373">Status code: 404</strong></p>
|
|
<p id="CreateCustomAuthorizerV2_1__p191731512183718">Not Found</p>
|
|
<pre class="screen" id="CreateCustomAuthorizerV2_1__screen51735121375">{
|
|
"error_code" : "APIG.3019",
|
|
"error_msg" : "The function URN does not exist"
|
|
}</pre>
|
|
<p id="CreateCustomAuthorizerV2_1__p10174181214379"><strong id="CreateCustomAuthorizerV2_1__b1417421211379">Status code: 500</strong></p>
|
|
<p id="CreateCustomAuthorizerV2_1__p117416124377">Internal Server Error</p>
|
|
<pre class="screen" id="CreateCustomAuthorizerV2_1__screen217410121376">{
|
|
"error_code" : "APIG.9999",
|
|
"error_msg" : "System error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="CreateCustomAuthorizerV2_1__section817519124378"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateCustomAuthorizerV2_1__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateCustomAuthorizerV2_1__row18779121003712"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateCustomAuthorizerV2_1__p1817518124371">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateCustomAuthorizerV2_1__p617513126378">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateCustomAuthorizerV2_1__row177961013373"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateCustomAuthorizerV2_1__p1417591210377">201</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateCustomAuthorizerV2_1__p16175212183718">Created</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row107791710173717"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateCustomAuthorizerV2_1__p12176012103715">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateCustomAuthorizerV2_1__p15176912143719">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row10779181019377"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateCustomAuthorizerV2_1__p15176151253712">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateCustomAuthorizerV2_1__p2176712163717">Unauthorized</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row19779131019374"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateCustomAuthorizerV2_1__p16176112103720">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateCustomAuthorizerV2_1__p181761121371">Forbidden</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row0780181083715"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateCustomAuthorizerV2_1__p5176412113714">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateCustomAuthorizerV2_1__p4177191263717">Not Found</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateCustomAuthorizerV2_1__row1378071013712"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateCustomAuthorizerV2_1__p7177101243717">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateCustomAuthorizerV2_1__p9177191253720">Internal Server Error</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateCustomAuthorizerV2_1__section131771412113714"><h4 class="sectiontitle">Error Codes</h4><p id="CreateCustomAuthorizerV2_1__p1177812123717">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="CustomAuthorizerManagement_1.html">Custom Authorizer Management</a></div>
|
|
</div>
|
|
</div>
|
|
|