cdk-serverless 3.3.2 → 3.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-233633-review.md +98 -0
- package/.agents/tasks/task-dependency-cve-upgrade/2026-10-12-234937-review.md +86 -0
- package/.agents/tasks/task-dependency-cve-upgrade/context.json +24 -0
- package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-001.json +28 -0
- package/.agents/tasks/task-dependency-cve-upgrade/features/FEAT-002.json +33 -0
- package/.agents/tasks/task-dependency-cve-upgrade/task.json +7 -0
- package/docs/constructs/assets/hierarchy.js +1 -1
- package/docs/constructs/assets/highlight.css +1 -1
- package/docs/constructs/assets/main.js +1 -1
- package/docs/constructs/assets/style.css +18 -3
- package/docs/constructs/classes/AssetCdn.html +161 -20
- package/docs/constructs/classes/BaseApi.html +153 -13
- package/docs/constructs/classes/CognitoAuthentication.html +188 -22
- package/docs/constructs/classes/GraphQlApi.html +349 -23
- package/docs/constructs/classes/LambdaFunction.html +1074 -106
- package/docs/constructs/classes/McpAuth.html +152 -16
- package/docs/constructs/classes/McpCognitoAuth.html +152 -16
- package/docs/constructs/classes/RestApi.html +344 -37
- package/docs/constructs/classes/SingleTableDatastore.html +173 -19
- package/docs/constructs/classes/Workflow.html +170 -21
- package/docs/constructs/hierarchy.html +47 -1
- package/docs/constructs/index.html +75 -2
- package/docs/constructs/interfaces/AssetCdnProps.html +61 -5
- package/docs/constructs/interfaces/BaseApiProps.html +141 -20
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +135 -20
- package/docs/constructs/interfaces/GraphQlApiProps.html +164 -22
- package/docs/constructs/interfaces/ICognitoAuthentication.html +57 -3
- package/docs/constructs/interfaces/IJwtAuthentication.html +63 -5
- package/docs/constructs/interfaces/ISingleTableDatastore.html +57 -3
- package/docs/constructs/interfaces/JsResolverOptions.html +66 -6
- package/docs/constructs/interfaces/LambdaFunctionProps.html +126 -18
- package/docs/constructs/interfaces/LambdaTracingOptions.html +57 -4
- package/docs/constructs/interfaces/McpAuthCognitoOptions.html +75 -8
- package/docs/constructs/interfaces/McpAuthFunctions.html +76 -8
- package/docs/constructs/interfaces/McpAuthGenericOptions.html +66 -6
- package/docs/constructs/interfaces/McpAuthOptions.html +107 -15
- package/docs/constructs/interfaces/McpAuthProps.html +123 -18
- package/docs/constructs/interfaces/McpCognitoAuthProps.html +127 -19
- package/docs/constructs/interfaces/RestApiProps.html +237 -37
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +77 -9
- package/docs/constructs/interfaces/SingleTableDesign.html +72 -7
- package/docs/constructs/interfaces/VtlResolverOptions.html +62 -5
- package/docs/constructs/interfaces/WorkflowProps.html +63 -2
- package/docs/constructs/modules.html +44 -1
- package/docs/constructs/types/LambdaOptions.html +31 -1
- package/docs/lambda/assets/highlight.css +1 -1
- package/docs/lambda/assets/main.js +1 -1
- package/docs/lambda/assets/style.css +18 -3
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +248 -21
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +247 -20
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +248 -21
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +246 -20
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +242 -21
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +235 -20
- package/docs/lambda/classes/auth.JwtAuthorizer.html +225 -20
- package/docs/lambda/classes/errors.BadRequestError.html +147 -11
- package/docs/lambda/classes/errors.ForbiddenError.html +147 -11
- package/docs/lambda/classes/errors.HttpError.html +154 -12
- package/docs/lambda/classes/errors.NotFoundError.html +147 -11
- package/docs/lambda/classes/errors.UnauthenticatedError.html +147 -11
- package/docs/lambda/functions/api.createAppSyncHandler.html +50 -3
- package/docs/lambda/functions/api.createHttpHandler.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandler.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +48 -2
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +47 -2
- package/docs/lambda/hierarchy.html +52 -1
- package/docs/lambda/index.html +75 -2
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +68 -3
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +67 -3
- package/docs/lambda/interfaces/api.HttpResponseContext.html +61 -3
- package/docs/lambda/interfaces/api.Operation.html +61 -3
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +65 -3
- package/docs/lambda/modules/api.html +45 -1
- package/docs/lambda/modules/auth.html +37 -1
- package/docs/lambda/modules/errors.html +37 -1
- package/docs/lambda/modules.html +36 -1
- package/docs/lambda/types/api.APIGatewayv1Handler.html +34 -2
- package/docs/lambda/types/api.AppSyncHandler.html +51 -2
- package/docs/lambda/types/api.HttpHandler.html +52 -2
- package/docs/projen/assets/highlight.css +5 -12
- package/docs/projen/assets/main.js +1 -1
- package/docs/projen/assets/style.css +18 -3
- package/docs/projen/classes/Datastore.html +254 -18
- package/docs/projen/classes/GraphQlApi.html +238 -18
- package/docs/projen/classes/RestApi.html +325 -40
- package/docs/projen/classes/ServerlessProject.html +1021 -159
- package/docs/projen/classes/Workflow.html +288 -31
- package/docs/projen/hierarchy.html +29 -1
- package/docs/projen/index.html +75 -2
- package/docs/projen/interfaces/DatastoreOptions.html +54 -2
- package/docs/projen/interfaces/GraphQlApiOptions.html +54 -2
- package/docs/projen/interfaces/RestApiOptions.html +54 -2
- package/docs/projen/interfaces/ServerlessProjectOptions.html +2089 -692
- package/docs/projen/interfaces/WorkflowOptions.html +54 -2
- package/docs/projen/modules.html +44 -1
- package/docs/projen/variables/PACKAGE_NAME.html +31 -1
- package/package.json +26 -24
|
@@ -1,13 +1,49 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ApiGatewayv2JwtAuthorizer | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ApiGatewayv2JwtAuthorizer | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">cdk-serverless</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="../modules/auth.html">auth</a></li>
|
|
12
|
+
<li><a href="" aria-current="page">ApiGatewayv2JwtAuthorizer</a></li></ul>
|
|
13
|
+
<h1>Class ApiGatewayv2JwtAuthorizer</h1></div>
|
|
14
|
+
<section class="tsd-panel tsd-comment">
|
|
15
|
+
<div class="tsd-comment tsd-typography"><p>Implements JWT Authorization on API Gateway v2 (HTTP API).</p>
|
|
16
|
+
</div></section>
|
|
17
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="119">
|
|
18
|
+
<h4>Hierarchy (<a href="../hierarchy.html#auth.ApiGatewayv2JwtAuthorizer">View Summary</a>)</h4>
|
|
19
|
+
<ul class="tsd-hierarchy">
|
|
20
|
+
<li class="tsd-hierarchy-item"><a href="auth.JwtAuthorizer.html" class="tsd-signature-type tsd-kind-class">JwtAuthorizer</a>
|
|
21
|
+
<ul class="tsd-hierarchy">
|
|
22
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ApiGatewayv2JwtAuthorizer</span>
|
|
23
|
+
<ul class="tsd-hierarchy">
|
|
24
|
+
<li class="tsd-hierarchy-item"><a href="auth.ApiGatewayv2CognitoAuthorizer.html" class="tsd-signature-type tsd-kind-class">ApiGatewayv2CognitoAuthorizer</a></li></ul></li></ul></li></ul></section>
|
|
25
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
26
|
+
<section class="tsd-panel tsd-index-panel">
|
|
27
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
28
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
29
|
+
<div class="tsd-accordion-details">
|
|
30
|
+
<section class="tsd-index-section">
|
|
31
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
32
|
+
<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
33
|
+
</div></section>
|
|
34
|
+
<section class="tsd-index-section">
|
|
35
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
36
|
+
<div class="tsd-index-list"><a href="#_logger" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>logger</span></a>
|
|
4
37
|
<a href="#adminclaim" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>admin<wbr/>Claim</span></a>
|
|
5
38
|
<a href="#claims" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>claims?</span></a>
|
|
6
39
|
<a href="#event" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event</span></a>
|
|
7
40
|
<a href="#groupclaim" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>group<wbr/>Claim</span></a>
|
|
8
41
|
<a href="#issuerurl" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>issuer<wbr/>Url</span></a>
|
|
9
42
|
<a href="#jwksurl" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jwks<wbr/>Url?</span></a>
|
|
10
|
-
</div></section
|
|
43
|
+
</div></section>
|
|
44
|
+
<section class="tsd-index-section">
|
|
45
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
46
|
+
<div class="tsd-index-list"><a href="#assertadmin" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assert<wbr/>Admin</span></a>
|
|
11
47
|
<a href="#assertauthenticated" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assert<wbr/>Authenticated</span></a>
|
|
12
48
|
<a href="#assertgroup" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assert<wbr/>Group</span></a>
|
|
13
49
|
<a href="#authenticate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>authenticate</span></a>
|
|
@@ -18,23 +54,213 @@
|
|
|
18
54
|
<a href="#hasgroup" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Group</span></a>
|
|
19
55
|
<a href="#isadmin" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Admin</span></a>
|
|
20
56
|
<a href="#isauthenticated" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Authenticated</span></a>
|
|
21
|
-
</div></section></div></details></section></section
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
57
|
+
</div></section></div></details></section></section>
|
|
58
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
59
|
+
<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
60
|
+
<section>
|
|
61
|
+
<section class="tsd-panel tsd-member">
|
|
62
|
+
<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
63
|
+
<ul class="tsd-signatures">
|
|
64
|
+
<li class="">
|
|
65
|
+
<div class="tsd-signature tsd-anchor-link" id="constructorapigatewayv2jwtauthorizer"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ApiGatewayv2JwtAuthorizer</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">APIGatewayProxyEventV2WithJWTAuthorizer</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">_logger</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LambdaLog</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ApiGatewayv2JwtAuthorizer</a><a href="#constructorapigatewayv2jwtauthorizer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
66
|
+
<div class="tsd-description">
|
|
67
|
+
<div class="tsd-parameters">
|
|
68
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
69
|
+
<ul class="tsd-parameter-list">
|
|
70
|
+
<li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">APIGatewayProxyEventV2WithJWTAuthorizer</span></span></li>
|
|
71
|
+
<li><span><span class="tsd-kind-parameter">_logger</span>: <span class="tsd-signature-type">LambdaLog</span></span></li></ul></div>
|
|
72
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ApiGatewayv2JwtAuthorizer</a></h4><aside class="tsd-sources">
|
|
73
|
+
<p>Overrides <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#constructor">constructor</a></p></aside></div></li></ul></section></section></details>
|
|
74
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
75
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
76
|
+
<section>
|
|
77
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
78
|
+
<h3 class="tsd-anchor-link" id="_logger"><code class="tsd-tag">Protected</code><span>_<wbr/>logger</span><a href="#_logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
79
|
+
<div class="tsd-signature"><span class="tsd-kind-property">_logger</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">LambdaLog</span></div></section>
|
|
80
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited">
|
|
81
|
+
<h3 class="tsd-anchor-link" id="adminclaim"><code class="tsd-tag">Protected</code><span>admin<wbr/>Claim</span><a href="#adminclaim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
82
|
+
<div class="tsd-signature"><span class="tsd-kind-property">adminClaim</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
83
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#adminclaim">adminClaim</a></p></aside></section>
|
|
84
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited">
|
|
85
|
+
<h3 class="tsd-anchor-link" id="claims"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Optional</code><span>claims</span><a href="#claims" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
86
|
+
<div class="tsd-signature"><span class="tsd-kind-property">claims</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span></div>
|
|
87
|
+
<div class="tsd-comment tsd-typography"><p>The claims of the authenticated user.</p>
|
|
88
|
+
</div><aside class="tsd-sources">
|
|
89
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#claims">claims</a></p></aside></section>
|
|
90
|
+
<section class="tsd-panel tsd-member tsd-is-protected">
|
|
91
|
+
<h3 class="tsd-anchor-link" id="event"><code class="tsd-tag">Protected</code><span>event</span><a href="#event" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
92
|
+
<div class="tsd-signature"><span class="tsd-kind-property">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">APIGatewayProxyEventV2WithJWTAuthorizer</span></div></section>
|
|
93
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited">
|
|
94
|
+
<h3 class="tsd-anchor-link" id="groupclaim"><code class="tsd-tag">Protected</code><span>group<wbr/>Claim</span><a href="#groupclaim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
95
|
+
<div class="tsd-signature"><span class="tsd-kind-property">groupClaim</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
96
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#groupclaim">groupClaim</a></p></aside></section>
|
|
97
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited">
|
|
98
|
+
<h3 class="tsd-anchor-link" id="issuerurl"><code class="tsd-tag">Protected</code><span>issuer<wbr/>Url</span><a href="#issuerurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
99
|
+
<div class="tsd-signature"><span class="tsd-kind-property">issuerUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
100
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#issuerurl">issuerUrl</a></p></aside></section>
|
|
101
|
+
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited">
|
|
102
|
+
<h3 class="tsd-anchor-link" id="jwksurl"><code class="tsd-tag">Protected</code> <code class="tsd-tag">Optional</code><span>jwks<wbr/>Url</span><a href="#jwksurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
103
|
+
<div class="tsd-signature"><span class="tsd-kind-property">jwksUrl</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
104
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#jwksurl">jwksUrl</a></p></aside></section></section></details>
|
|
105
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
106
|
+
<h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
107
|
+
<section>
|
|
108
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
109
|
+
<h3 class="tsd-anchor-link" id="assertadmin"><span>assert<wbr/>Admin</span><a href="#assertadmin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
110
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
111
|
+
<li class="tsd-is-inherited">
|
|
112
|
+
<div class="tsd-signature tsd-anchor-link" id="assertadmin-1"><span class="tsd-kind-call-signature">assertAdmin</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#assertadmin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
113
|
+
<div class="tsd-description">
|
|
114
|
+
<div class="tsd-comment tsd-typography"><p>Throws a ForbiddenError if the user is not authenticated or is not an admin.</p>
|
|
115
|
+
</div>
|
|
116
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
117
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#assertadmin">assertAdmin</a></p></aside></div></li></ul></section>
|
|
118
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
119
|
+
<h3 class="tsd-anchor-link" id="assertauthenticated"><span>assert<wbr/>Authenticated</span><a href="#assertauthenticated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
120
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
121
|
+
<li class="tsd-is-inherited">
|
|
122
|
+
<div class="tsd-signature tsd-anchor-link" id="assertauthenticated-1"><span class="tsd-kind-call-signature">assertAuthenticated</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#assertauthenticated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
123
|
+
<div class="tsd-description">
|
|
124
|
+
<div class="tsd-comment tsd-typography"><p>Throws an UnauthenticatedError if the user is not authenticated.</p>
|
|
125
|
+
</div>
|
|
126
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
127
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#assertauthenticated">assertAuthenticated</a></p></aside></div></li></ul></section>
|
|
128
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
129
|
+
<h3 class="tsd-anchor-link" id="assertgroup"><span>assert<wbr/>Group</span><a href="#assertgroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
130
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
131
|
+
<li class="tsd-is-inherited">
|
|
132
|
+
<div class="tsd-signature tsd-anchor-link" id="assertgroup-1"><span class="tsd-kind-call-signature">assertGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">group</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#assertgroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
133
|
+
<div class="tsd-description">
|
|
134
|
+
<div class="tsd-comment tsd-typography"><p>Throws a ForbiddenError if the user is not authenticated or does not belong
|
|
25
135
|
to the specified group.</p>
|
|
26
|
-
</div
|
|
27
|
-
|
|
136
|
+
</div>
|
|
137
|
+
<div class="tsd-parameters">
|
|
138
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
139
|
+
<ul class="tsd-parameter-list">
|
|
140
|
+
<li><span><span class="tsd-kind-parameter">group</span>: <span class="tsd-signature-type">string</span></span>
|
|
141
|
+
<div class="tsd-comment tsd-typography"><p>The name of the group to check.</p>
|
|
142
|
+
</div></li></ul></div>
|
|
143
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
144
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#assertgroup">assertGroup</a></p></aside></div></li></ul></section>
|
|
145
|
+
<section class="tsd-panel tsd-member">
|
|
146
|
+
<h3 class="tsd-anchor-link" id="authenticate"><span>authenticate</span><a href="#authenticate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
147
|
+
<ul class="tsd-signatures">
|
|
148
|
+
<li class="">
|
|
149
|
+
<div class="tsd-signature tsd-anchor-link" id="authenticate-1"><span class="tsd-kind-call-signature">authenticate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#authenticate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
150
|
+
<div class="tsd-description">
|
|
151
|
+
<div class="tsd-comment tsd-typography"><p>Authenticates the user using the claims provided by the API Gateway event or
|
|
28
152
|
by decoding a JWT token from the 'Authorization' header.</p>
|
|
29
|
-
</div
|
|
153
|
+
</div>
|
|
154
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
155
|
+
<p>Overrides <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#authenticate">authenticate</a></p></aside></div></li></ul></section>
|
|
156
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
157
|
+
<h3 class="tsd-anchor-link" id="getclaim"><span>get<wbr/>Claim</span><a href="#getclaim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
158
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
159
|
+
<li class="tsd-is-inherited">
|
|
160
|
+
<div class="tsd-signature tsd-anchor-link" id="getclaim-1"><span class="tsd-kind-call-signature">getClaim</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#getclaim-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
161
|
+
<div class="tsd-description">
|
|
162
|
+
<div class="tsd-comment tsd-typography"><p>Returns the value of the claim with the specified name, or undefined if the
|
|
30
163
|
claim does not exist.</p>
|
|
31
|
-
</div
|
|
32
|
-
|
|
33
|
-
|
|
164
|
+
</div>
|
|
165
|
+
<div class="tsd-parameters">
|
|
166
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
167
|
+
<ul class="tsd-parameter-list">
|
|
168
|
+
<li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span>
|
|
169
|
+
<div class="tsd-comment tsd-typography"><p>The name of the claim to retrieve.</p>
|
|
170
|
+
</div></li></ul></div>
|
|
171
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
|
|
172
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#getclaim">getClaim</a></p></aside></div></li></ul></section>
|
|
173
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
174
|
+
<h3 class="tsd-anchor-link" id="getemail"><span>get<wbr/>E<wbr/>Mail</span><a href="#getemail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
175
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
176
|
+
<li class="tsd-is-inherited">
|
|
177
|
+
<div class="tsd-signature tsd-anchor-link" id="getemail-1"><span class="tsd-kind-call-signature">getEMail</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getemail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
178
|
+
<div class="tsd-description">
|
|
179
|
+
<div class="tsd-comment tsd-typography"><p>Returns the email of the authenticated user.</p>
|
|
180
|
+
</div>
|
|
181
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
182
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#getemail">getEMail</a></p></aside></div></li></ul></section>
|
|
183
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
184
|
+
<h3 class="tsd-anchor-link" id="getgroups"><span>get<wbr/>Groups</span><a href="#getgroups" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
185
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
186
|
+
<li class="tsd-is-inherited">
|
|
187
|
+
<div class="tsd-signature tsd-anchor-link" id="getgroups-1"><span class="tsd-kind-call-signature">getGroups</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#getgroups-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
188
|
+
<div class="tsd-description">
|
|
189
|
+
<div class="tsd-comment tsd-typography"><p>Returns an array of groups the user belongs to, or an empty array if the user
|
|
34
190
|
is not authenticated or has no groups.</p>
|
|
35
|
-
</div
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
191
|
+
</div>
|
|
192
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
|
|
193
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#getgroups">getGroups</a></p></aside></div></li></ul></section>
|
|
194
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
195
|
+
<h3 class="tsd-anchor-link" id="getsubject"><span>get<wbr/>Subject</span><a href="#getsubject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
196
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
197
|
+
<li class="tsd-is-inherited">
|
|
198
|
+
<div class="tsd-signature tsd-anchor-link" id="getsubject-1"><span class="tsd-kind-call-signature">getSubject</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#getsubject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
199
|
+
<div class="tsd-description">
|
|
200
|
+
<div class="tsd-comment tsd-typography"><p>Returns the subject of the authenticated user.</p>
|
|
201
|
+
</div>
|
|
202
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
203
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#getsubject">getSubject</a></p></aside></div></li></ul></section>
|
|
204
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
205
|
+
<h3 class="tsd-anchor-link" id="hasgroup"><span>has<wbr/>Group</span><a href="#hasgroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
206
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
207
|
+
<li class="tsd-is-inherited">
|
|
208
|
+
<div class="tsd-signature tsd-anchor-link" id="hasgroup-1"><span class="tsd-kind-call-signature">hasGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">group</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#hasgroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
209
|
+
<div class="tsd-description">
|
|
210
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if the user belongs to the specified group, false otherwise.</p>
|
|
211
|
+
</div>
|
|
212
|
+
<div class="tsd-parameters">
|
|
213
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
214
|
+
<ul class="tsd-parameter-list">
|
|
215
|
+
<li><span><span class="tsd-kind-parameter">group</span>: <span class="tsd-signature-type">string</span></span>
|
|
216
|
+
<div class="tsd-comment tsd-typography"><p>The name of the group to check.</p>
|
|
217
|
+
</div></li></ul></div>
|
|
218
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
219
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#hasgroup">hasGroup</a></p></aside></div></li></ul></section>
|
|
220
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
221
|
+
<h3 class="tsd-anchor-link" id="isadmin"><span>is<wbr/>Admin</span><a href="#isadmin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
222
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
223
|
+
<li class="tsd-is-inherited">
|
|
224
|
+
<div class="tsd-signature tsd-anchor-link" id="isadmin-1"><span class="tsd-kind-call-signature">isAdmin</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isadmin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
225
|
+
<div class="tsd-description">
|
|
226
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if the user belongs to the 'admin' group, false otherwise.</p>
|
|
227
|
+
</div>
|
|
228
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
229
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#isadmin">isAdmin</a></p></aside></div></li></ul></section>
|
|
230
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
231
|
+
<h3 class="tsd-anchor-link" id="isauthenticated"><span>is<wbr/>Authenticated</span><a href="#isauthenticated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
232
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
233
|
+
<li class="tsd-is-inherited">
|
|
234
|
+
<div class="tsd-signature tsd-anchor-link" id="isauthenticated-1"><span class="tsd-kind-call-signature">isAuthenticated</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#isauthenticated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
235
|
+
<div class="tsd-description">
|
|
236
|
+
<div class="tsd-comment tsd-typography"><p>Returns true if the user is authenticated, false otherwise.</p>
|
|
237
|
+
</div>
|
|
238
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
239
|
+
<p>Inherited from <a href="auth.JwtAuthorizer.html">JwtAuthorizer</a>.<a href="auth.JwtAuthorizer.html#isauthenticated">isAuthenticated</a></p></aside></div></li></ul></section></section></details></div>
|
|
240
|
+
<div class="col-sidebar">
|
|
241
|
+
<div class="page-menu">
|
|
242
|
+
<div class="tsd-navigation settings">
|
|
243
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
244
|
+
<h3>Settings</h3></summary>
|
|
245
|
+
<div class="tsd-accordion-details">
|
|
246
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
247
|
+
<ul id="tsd-filter-options">
|
|
248
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
249
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
250
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
251
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
252
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
253
|
+
<h3>On This Page</h3></summary>
|
|
254
|
+
<div class="tsd-accordion-details">
|
|
255
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
|
|
256
|
+
<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
|
|
257
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
258
|
+
<div><a href="#_logger" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>_<wbr/>logger</span></a><a href="#adminclaim" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>admin<wbr/>Claim</span></a><a href="#claims" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>claims</span></a><a href="#event" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>event</span></a><a href="#groupclaim" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>group<wbr/>Claim</span></a><a href="#issuerurl" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>issuer<wbr/>Url</span></a><a href="#jwksurl" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jwks<wbr/>Url</span></a></div></details>
|
|
259
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
|
|
260
|
+
<div><a href="#assertadmin" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assert<wbr/>Admin</span></a><a href="#assertauthenticated" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assert<wbr/>Authenticated</span></a><a href="#assertgroup" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assert<wbr/>Group</span></a><a href="#authenticate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>authenticate</span></a><a href="#getclaim" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Claim</span></a><a href="#getemail" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>E<wbr/>Mail</span></a><a href="#getgroups" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Groups</span></a><a href="#getsubject" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Subject</span></a><a href="#hasgroup" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>has<wbr/>Group</span></a><a href="#isadmin" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Admin</span></a><a href="#isauthenticated" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Authenticated</span></a></div></details></div></details></div>
|
|
261
|
+
<div class="site-menu">
|
|
262
|
+
<nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a>
|
|
263
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
264
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
265
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
266
|
+
<div class="overlay"></div></body></html>
|