cdk-serverless 2.1.0 → 2.2.0
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/.gitattributes +1 -0
- package/docs/constructs/assets/highlight.css +14 -14
- package/docs/constructs/assets/main.js +3 -3
- package/docs/constructs/assets/search.js +1 -1
- package/docs/constructs/assets/style.css +6 -4
- package/docs/constructs/classes/AssetCdn.html +62 -55
- package/docs/constructs/classes/BaseApi.html +54 -46
- package/docs/constructs/classes/CognitoAuthentication.html +64 -56
- package/docs/constructs/classes/GraphQlApi.html +384 -0
- package/docs/constructs/classes/LambdaFunction.html +433 -367
- package/docs/constructs/classes/RestApi.html +110 -97
- package/docs/constructs/classes/SingleTableDatastore.html +56 -49
- package/docs/constructs/classes/Workflow.html +62 -55
- package/docs/constructs/index.html +26 -23
- package/docs/constructs/interfaces/AssetCdnProps.html +35 -30
- package/docs/constructs/interfaces/BaseApiProps.html +73 -61
- package/docs/constructs/interfaces/CognitoAuthenticationProps.html +61 -48
- package/docs/constructs/interfaces/GraphQlApiProps.html +205 -0
- package/docs/constructs/interfaces/ICognitoAuthentication.html +30 -26
- package/docs/constructs/interfaces/IJwtAuthentication.html +40 -34
- package/docs/constructs/interfaces/LambdaFunctionProps.html +97 -80
- package/docs/constructs/interfaces/LambdaTracingOptions.html +31 -27
- package/docs/constructs/interfaces/RestApiProps.html +108 -92
- package/docs/constructs/interfaces/SingleTableDatastoreProps.html +44 -38
- package/docs/constructs/interfaces/SingleTableDesign.html +46 -39
- package/docs/constructs/interfaces/VtlResolverOptions.html +102 -0
- package/docs/constructs/interfaces/WorkflowProps.html +40 -37
- package/docs/constructs/modules.html +46 -40
- package/docs/constructs/types/LambdaOptions.html +24 -21
- package/docs/lambda/assets/highlight.css +11 -4
- package/docs/lambda/assets/main.js +3 -3
- package/docs/lambda/assets/style.css +6 -4
- package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +116 -123
- package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +114 -122
- package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +116 -123
- package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +114 -122
- package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +113 -120
- package/docs/lambda/classes/auth.CognitoAuthorizer.html +108 -116
- package/docs/lambda/classes/auth.JwtAuthorizer.html +108 -116
- package/docs/lambda/classes/errors.BadRequestError.html +43 -67
- package/docs/lambda/classes/errors.ForbiddenError.html +43 -67
- package/docs/lambda/classes/errors.HttpError.html +43 -67
- package/docs/lambda/classes/errors.NotFoundError.html +43 -67
- package/docs/lambda/classes/errors.UnauthenticatedError.html +43 -67
- package/docs/lambda/functions/api.createAppSyncHandler.html +23 -39
- package/docs/lambda/functions/api.createHttpHandler.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandler.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +21 -38
- package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +21 -38
- package/docs/lambda/index.html +7 -41
- package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +33 -50
- package/docs/lambda/interfaces/api.HttpHandlerContext.html +36 -53
- package/docs/lambda/interfaces/api.HttpResponseContext.html +30 -47
- package/docs/lambda/interfaces/api.Operation.html +24 -41
- package/docs/lambda/interfaces/api.OperationWithRequestBody.html +27 -44
- package/docs/lambda/modules/api.html +31 -49
- package/docs/lambda/modules/auth.html +19 -43
- package/docs/lambda/modules/errors.html +15 -41
- package/docs/lambda/modules.html +8 -42
- package/docs/lambda/types/api.APIGatewayv1Handler.html +20 -37
- package/docs/lambda/types/api.AppSyncHandler.html +20 -37
- package/docs/lambda/types/api.HttpHandler.html +20 -37
- package/docs/projen/assets/highlight.css +25 -18
- package/docs/projen/assets/main.js +3 -3
- package/docs/projen/assets/search.js +1 -1
- package/docs/projen/assets/style.css +6 -4
- package/docs/projen/classes/Datastore.html +54 -49
- package/docs/projen/classes/GraphQlApi.html +155 -0
- package/docs/projen/classes/RestApi.html +54 -49
- package/docs/projen/classes/ServerlessProject.html +590 -461
- package/docs/projen/classes/Workflow.html +54 -49
- package/docs/projen/index.html +15 -13
- package/docs/projen/interfaces/DatastoreOptions.html +20 -18
- package/docs/projen/interfaces/GraphQlApiOptions.html +77 -0
- package/docs/projen/interfaces/RestApiOptions.html +20 -18
- package/docs/projen/interfaces/ServerlessProjectOptions.html +979 -808
- package/docs/projen/interfaces/WorkflowOptions.html +20 -18
- package/docs/projen/modules.html +24 -20
- package/docs/projen/variables/PACKAGE_NAME.html +13 -11
- package/lib/constructs/graphql.d.ts +52 -0
- package/lib/constructs/graphql.js +310 -0
- package/lib/constructs/index.d.ts +1 -0
- package/lib/constructs/index.js +2 -1
- package/lib/projen/core.js +1 -2
- package/lib/projen/datastore.js +3 -4
- package/lib/projen/graphql.d.ts +10 -0
- package/lib/projen/graphql.js +90 -0
- package/lib/projen/index.d.ts +1 -0
- package/lib/projen/index.js +2 -2
- package/lib/projen/rest-api.js +3 -1
- package/package.json +8 -8
|
@@ -19,7 +19,8 @@
|
|
|
19
19
|
<section class="tsd-panel tsd-comment">
|
|
20
20
|
<div class="tsd-comment tsd-typography"><p>ApiGatewayv1CognitoAuthorizer is a specialization of an ApiGatewayv1JwtAuthorizer
|
|
21
21
|
and implements authentication logic for API Gateway v1 requests when using Cognito..</p>
|
|
22
|
-
</div
|
|
22
|
+
</div>
|
|
23
|
+
<div class="tsd-comment tsd-typography"></div></section>
|
|
23
24
|
<section class="tsd-panel tsd-hierarchy">
|
|
24
25
|
<h4>Hierarchy</h4>
|
|
25
26
|
<ul class="tsd-hierarchy">
|
|
@@ -33,38 +34,38 @@ and implements authentication logic for API Gateway v1 requests when using Cogni
|
|
|
33
34
|
<div class="tsd-accordion-details">
|
|
34
35
|
<section class="tsd-index-section">
|
|
35
36
|
<h3 class="tsd-index-heading">Constructors</h3>
|
|
36
|
-
<div class="tsd-index-list"><a href="auth.ApiGatewayv1CognitoAuthorizer.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon"
|
|
37
|
+
<div class="tsd-index-list"><a href="auth.ApiGatewayv1CognitoAuthorizer.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a>
|
|
37
38
|
</div></section>
|
|
38
39
|
<section class="tsd-index-section">
|
|
39
40
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
40
|
-
<div class="tsd-index-list"><a href="auth.ApiGatewayv1CognitoAuthorizer.html#_logger" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
41
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#adminClaim" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
42
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#claims" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
43
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#event" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
44
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#groupClaim" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
45
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#issuerUrl" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
46
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#jwksUrl" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
41
|
+
<div class="tsd-index-list"><a href="auth.ApiGatewayv1CognitoAuthorizer.html#_logger" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>_logger</span></a>
|
|
42
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#adminClaim" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>admin<wbr/>Claim</span></a>
|
|
43
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#claims" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>claims?</span></a>
|
|
44
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#event" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>event</span></a>
|
|
45
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#groupClaim" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>group<wbr/>Claim</span></a>
|
|
46
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#issuerUrl" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>issuer<wbr/>Url</span></a>
|
|
47
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#jwksUrl" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>jwks<wbr/>Url?</span></a>
|
|
47
48
|
</div></section>
|
|
48
49
|
<section class="tsd-index-section">
|
|
49
50
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
50
|
-
<div class="tsd-index-list"><a href="auth.ApiGatewayv1CognitoAuthorizer.html#assertAdmin" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
51
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#assertAuthenticated" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
52
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#assertGroup" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
53
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#authenticate" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
54
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#getClaim" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
55
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#getEMail" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
56
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#getGroups" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
57
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#getSubject" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
58
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#hasGroup" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
59
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#isAdmin" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
60
|
-
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#isAuthenticated" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
51
|
+
<div class="tsd-index-list"><a href="auth.ApiGatewayv1CognitoAuthorizer.html#assertAdmin" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>assert<wbr/>Admin</span></a>
|
|
52
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#assertAuthenticated" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>assert<wbr/>Authenticated</span></a>
|
|
53
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#assertGroup" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>assert<wbr/>Group</span></a>
|
|
54
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#authenticate" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>authenticate</span></a>
|
|
55
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#getClaim" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Claim</span></a>
|
|
56
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#getEMail" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>getEMail</span></a>
|
|
57
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#getGroups" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Groups</span></a>
|
|
58
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#getSubject" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Subject</span></a>
|
|
59
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#hasGroup" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Group</span></a>
|
|
60
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#isAdmin" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Admin</span></a>
|
|
61
|
+
<a href="auth.ApiGatewayv1CognitoAuthorizer.html#isAuthenticated" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Authenticated</span></a>
|
|
61
62
|
</div></section></div></details></section></section>
|
|
62
63
|
<section class="tsd-panel-group tsd-member-group">
|
|
63
64
|
<h2>Constructors</h2>
|
|
64
65
|
<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
|
|
65
|
-
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
66
|
+
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
|
|
66
67
|
<ul class="tsd-signatures">
|
|
67
|
-
<li class="tsd-signature tsd-anchor-link" id="constructor.new_ApiGatewayv1CognitoAuthorizer"><span class="tsd-kind-constructor-signature">new <wbr/>Api<wbr/>Gatewayv1<wbr/>Cognito<wbr/>Authorizer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">_logger</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="auth.ApiGatewayv1CognitoAuthorizer.html" class="tsd-signature-type tsd-kind-class">ApiGatewayv1CognitoAuthorizer</a><a href="#constructor.new_ApiGatewayv1CognitoAuthorizer" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
68
|
+
<li class="tsd-signature tsd-anchor-link" id="constructor.new_ApiGatewayv1CognitoAuthorizer"><span class="tsd-kind-constructor-signature">new <wbr/>Api<wbr/>Gatewayv1<wbr/>Cognito<wbr/>Authorizer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">_logger</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="auth.ApiGatewayv1CognitoAuthorizer.html" class="tsd-signature-type tsd-kind-class">ApiGatewayv1CognitoAuthorizer</a><a href="#constructor.new_ApiGatewayv1CognitoAuthorizer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
68
69
|
<li class="tsd-description">
|
|
69
70
|
<div class="tsd-comment tsd-typography"><p>The event that triggered the authorization check.</p>
|
|
70
71
|
</div>
|
|
@@ -75,20 +76,21 @@ and implements authentication logic for API Gateway v1 requests when using Cogni
|
|
|
75
76
|
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type ">APIGatewayProxyWithCognitoAuthorizerEvent</span></h5></li>
|
|
76
77
|
<li>
|
|
77
78
|
<h5><span class="tsd-kind-parameter">_logger</span>: <span class="tsd-signature-type ">LambdaLog</span></h5></li></ul></div>
|
|
78
|
-
<h4 class="tsd-returns-title">Returns <a href="auth.ApiGatewayv1CognitoAuthorizer.html" class="tsd-signature-type tsd-kind-class">ApiGatewayv1CognitoAuthorizer</a></h4
|
|
79
|
+
<h4 class="tsd-returns-title">Returns <a href="auth.ApiGatewayv1CognitoAuthorizer.html" class="tsd-signature-type tsd-kind-class">ApiGatewayv1CognitoAuthorizer</a></h4>
|
|
80
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
79
81
|
<p>Overrides <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#constructor">constructor</a></p></aside></li></ul></section></section>
|
|
80
82
|
<section class="tsd-panel-group tsd-member-group">
|
|
81
83
|
<h2>Properties</h2>
|
|
82
84
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="_logger" class="tsd-anchor"></a>
|
|
83
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_logger</span><a href="#_logger" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
85
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>_logger</span><a href="#_logger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
84
86
|
<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><aside class="tsd-sources">
|
|
85
87
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#_logger">_logger</a></p></aside></section>
|
|
86
88
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="adminClaim" class="tsd-anchor"></a>
|
|
87
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>admin<wbr/>Claim</span><a href="#adminClaim" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
89
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>admin<wbr/>Claim</span><a href="#adminClaim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
88
90
|
<div class="tsd-signature"><span class="tsd-kind-property">admin<wbr/>Claim</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
89
91
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#adminClaim">adminClaim</a></p></aside></section>
|
|
90
92
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="claims" class="tsd-anchor"></a>
|
|
91
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>claims</span><a href="#claims" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
93
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>claims</span><a href="#claims" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
92
94
|
<div class="tsd-signature"><span class="tsd-kind-property">claims</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span>[<span class="tsd-kind-index-signature">name</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><br/><span class="tsd-signature-symbol">}</span></div>
|
|
93
95
|
<div class="tsd-comment tsd-typography"><p>The claims of the authenticated user.</p>
|
|
94
96
|
</div>
|
|
@@ -96,48 +98,51 @@ and implements authentication logic for API Gateway v1 requests when using Cogni
|
|
|
96
98
|
<h4>Type declaration</h4>
|
|
97
99
|
<ul class="tsd-parameters">
|
|
98
100
|
<li class="tsd-parameter-index-signature">
|
|
99
|
-
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">name</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></h5></li></ul></div
|
|
101
|
+
<h5><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">name</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></h5></li></ul></div>
|
|
102
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
100
103
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#claims">claims</a></p></aside></section>
|
|
101
104
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="event" class="tsd-anchor"></a>
|
|
102
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>event</span><a href="#event" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
105
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>event</span><a href="#event" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
103
106
|
<div class="tsd-signature"><span class="tsd-kind-property">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">APIGatewayProxyWithCognitoAuthorizerEvent</span></div><aside class="tsd-sources">
|
|
104
107
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#event">event</a></p></aside></section>
|
|
105
108
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="groupClaim" class="tsd-anchor"></a>
|
|
106
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>group<wbr/>Claim</span><a href="#groupClaim" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
109
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>group<wbr/>Claim</span><a href="#groupClaim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
107
110
|
<div class="tsd-signature"><span class="tsd-kind-property">group<wbr/>Claim</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
108
111
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#groupClaim">groupClaim</a></p></aside></section>
|
|
109
112
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="issuerUrl" class="tsd-anchor"></a>
|
|
110
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>issuer<wbr/>Url</span><a href="#issuerUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
113
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>issuer<wbr/>Url</span><a href="#issuerUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
111
114
|
<div class="tsd-signature"><span class="tsd-kind-property">issuer<wbr/>Url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
112
115
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#issuerUrl">issuerUrl</a></p></aside></section>
|
|
113
116
|
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="jwksUrl" class="tsd-anchor"></a>
|
|
114
|
-
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>jwks<wbr/>Url</span><a href="#jwksUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
117
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>jwks<wbr/>Url</span><a href="#jwksUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
115
118
|
<div class="tsd-signature"><span class="tsd-kind-property">jwks<wbr/>Url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
116
119
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#jwksUrl">jwksUrl</a></p></aside></section></section>
|
|
117
120
|
<section class="tsd-panel-group tsd-member-group">
|
|
118
121
|
<h2>Methods</h2>
|
|
119
122
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="assertAdmin" class="tsd-anchor"></a>
|
|
120
|
-
<h3 class="tsd-anchor-link"><span>assert<wbr/>Admin</span><a href="#assertAdmin" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
123
|
+
<h3 class="tsd-anchor-link"><span>assert<wbr/>Admin</span><a href="#assertAdmin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
121
124
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
122
|
-
<li class="tsd-signature tsd-anchor-link" id="assertAdmin.assertAdmin-1"><span class="tsd-kind-call-signature">assert<wbr/>Admin</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#assertAdmin.assertAdmin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
125
|
+
<li class="tsd-signature tsd-anchor-link" id="assertAdmin.assertAdmin-1"><span class="tsd-kind-call-signature">assert<wbr/>Admin</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#assertAdmin.assertAdmin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
123
126
|
<li class="tsd-description">
|
|
124
127
|
<div class="tsd-comment tsd-typography"><p>Throws a ForbiddenError if the user is not authenticated or is not an admin.</p>
|
|
125
128
|
</div>
|
|
126
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
129
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
130
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
127
131
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#assertAdmin">assertAdmin</a></p></aside></li></ul></section>
|
|
128
132
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="assertAuthenticated" class="tsd-anchor"></a>
|
|
129
|
-
<h3 class="tsd-anchor-link"><span>assert<wbr/>Authenticated</span><a href="#assertAuthenticated" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
133
|
+
<h3 class="tsd-anchor-link"><span>assert<wbr/>Authenticated</span><a href="#assertAuthenticated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
130
134
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
131
|
-
<li class="tsd-signature tsd-anchor-link" id="assertAuthenticated.assertAuthenticated-1"><span class="tsd-kind-call-signature">assert<wbr/>Authenticated</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#assertAuthenticated.assertAuthenticated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
135
|
+
<li class="tsd-signature tsd-anchor-link" id="assertAuthenticated.assertAuthenticated-1"><span class="tsd-kind-call-signature">assert<wbr/>Authenticated</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#assertAuthenticated.assertAuthenticated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
132
136
|
<li class="tsd-description">
|
|
133
137
|
<div class="tsd-comment tsd-typography"><p>Throws an UnauthenticatedError if the user is not authenticated.</p>
|
|
134
138
|
</div>
|
|
135
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4
|
|
139
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
140
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
136
141
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#assertAuthenticated">assertAuthenticated</a></p></aside></li></ul></section>
|
|
137
142
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="assertGroup" class="tsd-anchor"></a>
|
|
138
|
-
<h3 class="tsd-anchor-link"><span>assert<wbr/>Group</span><a href="#assertGroup" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
143
|
+
<h3 class="tsd-anchor-link"><span>assert<wbr/>Group</span><a href="#assertGroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
139
144
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
140
|
-
<li class="tsd-signature tsd-anchor-link" id="assertGroup.assertGroup-1"><span class="tsd-kind-call-signature">assert<wbr/>Group</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">group</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#assertGroup.assertGroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
145
|
+
<li class="tsd-signature tsd-anchor-link" id="assertGroup.assertGroup-1"><span class="tsd-kind-call-signature">assert<wbr/>Group</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">group</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#assertGroup.assertGroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
141
146
|
<li class="tsd-description">
|
|
142
147
|
<div class="tsd-comment tsd-typography"><p>Throws a ForbiddenError if the user is not authenticated or does not belong
|
|
143
148
|
to the specified group.</p>
|
|
@@ -148,23 +153,26 @@ to the specified group.</p>
|
|
|
148
153
|
<li>
|
|
149
154
|
<h5><span class="tsd-kind-parameter">group</span>: <span class="tsd-signature-type">string</span></h5>
|
|
150
155
|
<div class="tsd-comment tsd-typography"><p>The name of the group to check.</p>
|
|
151
|
-
</div
|
|
152
|
-
<
|
|
156
|
+
</div>
|
|
157
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
158
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
159
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
153
160
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#assertGroup">assertGroup</a></p></aside></li></ul></section>
|
|
154
161
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="authenticate" class="tsd-anchor"></a>
|
|
155
|
-
<h3 class="tsd-anchor-link"><span>authenticate</span><a href="#authenticate" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
162
|
+
<h3 class="tsd-anchor-link"><span>authenticate</span><a href="#authenticate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
156
163
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
157
|
-
<li class="tsd-signature tsd-anchor-link" id="authenticate.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-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.authenticate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
164
|
+
<li class="tsd-signature tsd-anchor-link" id="authenticate.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-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.authenticate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
158
165
|
<li class="tsd-description">
|
|
159
166
|
<div class="tsd-comment tsd-typography"><p>Authenticates the user using the claims provided by the API Gateway event or
|
|
160
167
|
by decoding a JWT token from the 'Authorization' header.</p>
|
|
161
168
|
</div>
|
|
162
|
-
<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
|
|
169
|
+
<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>
|
|
170
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
163
171
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#authenticate">authenticate</a></p></aside></li></ul></section>
|
|
164
172
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getClaim" class="tsd-anchor"></a>
|
|
165
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Claim</span><a href="#getClaim" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
173
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Claim</span><a href="#getClaim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
166
174
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
167
|
-
<li class="tsd-signature tsd-anchor-link" id="getClaim.getClaim-1"><span class="tsd-kind-call-signature">get<wbr/>Claim</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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><a href="#getClaim.getClaim-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
175
|
+
<li class="tsd-signature tsd-anchor-link" id="getClaim.getClaim-1"><span class="tsd-kind-call-signature">get<wbr/>Claim</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</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><a href="#getClaim.getClaim-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
168
176
|
<li class="tsd-description">
|
|
169
177
|
<div class="tsd-comment tsd-typography"><p>Returns the value of the claim with the specified name, or undefined if the
|
|
170
178
|
claim does not exist.</p>
|
|
@@ -175,41 +183,46 @@ claim does not exist.</p>
|
|
|
175
183
|
<li>
|
|
176
184
|
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5>
|
|
177
185
|
<div class="tsd-comment tsd-typography"><p>The name of the claim to retrieve.</p>
|
|
178
|
-
</div
|
|
179
|
-
<
|
|
186
|
+
</div>
|
|
187
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
188
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</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></h4>
|
|
189
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
180
190
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#getClaim">getClaim</a></p></aside></li></ul></section>
|
|
181
191
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getEMail" class="tsd-anchor"></a>
|
|
182
|
-
<h3 class="tsd-anchor-link"><span>getEMail</span><a href="#getEMail" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
192
|
+
<h3 class="tsd-anchor-link"><span>getEMail</span><a href="#getEMail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
183
193
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
184
|
-
<li class="tsd-signature tsd-anchor-link" id="getEMail.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-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getEMail.getEMail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
194
|
+
<li class="tsd-signature tsd-anchor-link" id="getEMail.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-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getEMail.getEMail-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
185
195
|
<li class="tsd-description">
|
|
186
196
|
<div class="tsd-comment tsd-typography"><p>Returns the email of the authenticated user.</p>
|
|
187
197
|
</div>
|
|
188
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4
|
|
198
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
199
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
189
200
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#getEMail">getEMail</a></p></aside></li></ul></section>
|
|
190
201
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getGroups" class="tsd-anchor"></a>
|
|
191
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Groups</span><a href="#getGroups" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
202
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Groups</span><a href="#getGroups" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
192
203
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
193
|
-
<li class="tsd-signature tsd-anchor-link" id="getGroups.getGroups-1"><span class="tsd-kind-call-signature">get<wbr/>Groups</span><span class="tsd-signature-symbol">(</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.getGroups-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
204
|
+
<li class="tsd-signature tsd-anchor-link" id="getGroups.getGroups-1"><span class="tsd-kind-call-signature">get<wbr/>Groups</span><span class="tsd-signature-symbol">(</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.getGroups-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
194
205
|
<li class="tsd-description">
|
|
195
206
|
<div class="tsd-comment tsd-typography"><p>Returns an array of groups the user belongs to, or an empty array if the user
|
|
196
207
|
is not authenticated or has no groups.</p>
|
|
197
208
|
</div>
|
|
198
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4
|
|
209
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4>
|
|
210
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
199
211
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#getGroups">getGroups</a></p></aside></li></ul></section>
|
|
200
212
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="getSubject" class="tsd-anchor"></a>
|
|
201
|
-
<h3 class="tsd-anchor-link"><span>get<wbr/>Subject</span><a href="#getSubject" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
213
|
+
<h3 class="tsd-anchor-link"><span>get<wbr/>Subject</span><a href="#getSubject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
202
214
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
203
|
-
<li class="tsd-signature tsd-anchor-link" id="getSubject.getSubject-1"><span class="tsd-kind-call-signature">get<wbr/>Subject</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getSubject.getSubject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
215
|
+
<li class="tsd-signature tsd-anchor-link" id="getSubject.getSubject-1"><span class="tsd-kind-call-signature">get<wbr/>Subject</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getSubject.getSubject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
204
216
|
<li class="tsd-description">
|
|
205
217
|
<div class="tsd-comment tsd-typography"><p>Returns the subject of the authenticated user.</p>
|
|
206
218
|
</div>
|
|
207
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4
|
|
219
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
220
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
208
221
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#getSubject">getSubject</a></p></aside></li></ul></section>
|
|
209
222
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="hasGroup" class="tsd-anchor"></a>
|
|
210
|
-
<h3 class="tsd-anchor-link"><span>has<wbr/>Group</span><a href="#hasGroup" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
223
|
+
<h3 class="tsd-anchor-link"><span>has<wbr/>Group</span><a href="#hasGroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
211
224
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
212
|
-
<li class="tsd-signature tsd-anchor-link" id="hasGroup.hasGroup-1"><span class="tsd-kind-call-signature">has<wbr/>Group</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">group</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasGroup.hasGroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
225
|
+
<li class="tsd-signature tsd-anchor-link" id="hasGroup.hasGroup-1"><span class="tsd-kind-call-signature">has<wbr/>Group</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">group</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasGroup.hasGroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
213
226
|
<li class="tsd-description">
|
|
214
227
|
<div class="tsd-comment tsd-typography"><p>Returns true if the user belongs to the specified group, false otherwise.</p>
|
|
215
228
|
</div>
|
|
@@ -219,32 +232,36 @@ is not authenticated or has no groups.</p>
|
|
|
219
232
|
<li>
|
|
220
233
|
<h5><span class="tsd-kind-parameter">group</span>: <span class="tsd-signature-type">string</span></h5>
|
|
221
234
|
<div class="tsd-comment tsd-typography"><p>The name of the group to check.</p>
|
|
222
|
-
</div
|
|
223
|
-
<
|
|
235
|
+
</div>
|
|
236
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
|
237
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
238
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
224
239
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#hasGroup">hasGroup</a></p></aside></li></ul></section>
|
|
225
240
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="isAdmin" class="tsd-anchor"></a>
|
|
226
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Admin</span><a href="#isAdmin" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
241
|
+
<h3 class="tsd-anchor-link"><span>is<wbr/>Admin</span><a href="#isAdmin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
227
242
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
228
|
-
<li class="tsd-signature tsd-anchor-link" id="isAdmin.isAdmin-1"><span class="tsd-kind-call-signature">is<wbr/>Admin</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isAdmin.isAdmin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
243
|
+
<li class="tsd-signature tsd-anchor-link" id="isAdmin.isAdmin-1"><span class="tsd-kind-call-signature">is<wbr/>Admin</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isAdmin.isAdmin-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
229
244
|
<li class="tsd-description">
|
|
230
245
|
<div class="tsd-comment tsd-typography"><p>Returns true if the user belongs to the 'admin' group, false otherwise.</p>
|
|
231
246
|
</div>
|
|
232
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4
|
|
247
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
248
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
233
249
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#isAdmin">isAdmin</a></p></aside></li></ul></section>
|
|
234
250
|
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="isAuthenticated" class="tsd-anchor"></a>
|
|
235
|
-
<h3 class="tsd-anchor-link"><span>is<wbr/>Authenticated</span><a href="#isAuthenticated" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
251
|
+
<h3 class="tsd-anchor-link"><span>is<wbr/>Authenticated</span><a href="#isAuthenticated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
236
252
|
<ul class="tsd-signatures tsd-is-inherited">
|
|
237
|
-
<li class="tsd-signature tsd-anchor-link" id="isAuthenticated.isAuthenticated-1"><span class="tsd-kind-call-signature">is<wbr/>Authenticated</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isAuthenticated.isAuthenticated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg
|
|
253
|
+
<li class="tsd-signature tsd-anchor-link" id="isAuthenticated.isAuthenticated-1"><span class="tsd-kind-call-signature">is<wbr/>Authenticated</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isAuthenticated.isAuthenticated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
238
254
|
<li class="tsd-description">
|
|
239
255
|
<div class="tsd-comment tsd-typography"><p>Returns true if the user is authenticated, false otherwise.</p>
|
|
240
256
|
</div>
|
|
241
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4
|
|
257
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
258
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
242
259
|
<p>Inherited from <a href="auth.ApiGatewayv1JwtAuthorizer.html">ApiGatewayv1JwtAuthorizer</a>.<a href="auth.ApiGatewayv1JwtAuthorizer.html#isAuthenticated">isAuthenticated</a></p></aside></li></ul></section></section></div>
|
|
243
260
|
<div class="col-sidebar">
|
|
244
261
|
<div class="page-menu">
|
|
245
262
|
<div class="tsd-navigation settings">
|
|
246
263
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
247
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg>Settings</h3></summary>
|
|
264
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
|
|
248
265
|
<div class="tsd-accordion-details">
|
|
249
266
|
<div class="tsd-filter-visibility">
|
|
250
267
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
@@ -256,68 +273,44 @@ is not authenticated or has no groups.</p>
|
|
|
256
273
|
<div class="tsd-theme-toggle">
|
|
257
274
|
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
258
275
|
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
|
259
|
-
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><
|
|
276
|
+
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
|
260
277
|
<div class="tsd-accordion-details">
|
|
261
278
|
<ul>
|
|
262
|
-
<li><a href="#constructor" class=""><svg class="tsd-kind-icon"
|
|
263
|
-
<li><a href="#_logger" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
264
|
-
<li><a href="#adminClaim" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
265
|
-
<li><a href="#claims" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
266
|
-
<li><a href="#event" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
267
|
-
<li><a href="#groupClaim" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
268
|
-
<li><a href="#issuerUrl" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
269
|
-
<li><a href="#jwksUrl" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
270
|
-
<li><a href="#assertAdmin" class="tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
271
|
-
<li><a href="#assertAuthenticated" class="tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
272
|
-
<li><a href="#assertGroup" class="tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
273
|
-
<li><a href="#authenticate" class="tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
274
|
-
<li><a href="#getClaim" class="tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
275
|
-
<li><a href="#getEMail" class="tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
276
|
-
<li><a href="#getGroups" class="tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
277
|
-
<li><a href="#getSubject" class="tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
278
|
-
<li><a href="#hasGroup" class="tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
279
|
-
<li><a href="#isAdmin" class="tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
280
|
-
<li><a href="#isAuthenticated" class="tsd-is-inherited"><svg class="tsd-kind-icon"
|
|
279
|
+
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
|
|
280
|
+
<li><a href="#_logger" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>_logger</span></a></li>
|
|
281
|
+
<li><a href="#adminClaim" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>admin<wbr/>Claim</span></a></li>
|
|
282
|
+
<li><a href="#claims" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>claims</span></a></li>
|
|
283
|
+
<li><a href="#event" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>event</span></a></li>
|
|
284
|
+
<li><a href="#groupClaim" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>group<wbr/>Claim</span></a></li>
|
|
285
|
+
<li><a href="#issuerUrl" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>issuer<wbr/>Url</span></a></li>
|
|
286
|
+
<li><a href="#jwksUrl" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>jwks<wbr/>Url</span></a></li>
|
|
287
|
+
<li><a href="#assertAdmin" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>assert<wbr/>Admin</span></a></li>
|
|
288
|
+
<li><a href="#assertAuthenticated" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>assert<wbr/>Authenticated</span></a></li>
|
|
289
|
+
<li><a href="#assertGroup" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>assert<wbr/>Group</span></a></li>
|
|
290
|
+
<li><a href="#authenticate" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>authenticate</span></a></li>
|
|
291
|
+
<li><a href="#getClaim" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Claim</span></a></li>
|
|
292
|
+
<li><a href="#getEMail" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>getEMail</span></a></li>
|
|
293
|
+
<li><a href="#getGroups" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Groups</span></a></li>
|
|
294
|
+
<li><a href="#getSubject" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Subject</span></a></li>
|
|
295
|
+
<li><a href="#hasGroup" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>has<wbr/>Group</span></a></li>
|
|
296
|
+
<li><a href="#isAdmin" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Admin</span></a></li>
|
|
297
|
+
<li><a href="#isAuthenticated" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Authenticated</span></a></li></ul></div></details></div>
|
|
281
298
|
<div class="site-menu">
|
|
282
|
-
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon"
|
|
299
|
+
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
|
|
283
300
|
<ul class="tsd-small-nested-navigation">
|
|
301
|
+
<li><a href="../modules/api.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>api</span></a></li>
|
|
284
302
|
<li>
|
|
285
|
-
<details class="tsd-index-accordion" data-key="
|
|
286
|
-
<div class="tsd-accordion-details">
|
|
287
|
-
<ul class="tsd-nested-navigation">
|
|
288
|
-
<li><a href="../interfaces/api.AppSyncHandlerContext.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>App<wbr/>Sync<wbr/>Handler<wbr/>Context</span></a></li>
|
|
289
|
-
<li><a href="../interfaces/api.HttpHandlerContext.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Http<wbr/>Handler<wbr/>Context</span></a></li>
|
|
290
|
-
<li><a href="../interfaces/api.HttpResponseContext.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Http<wbr/>Response<wbr/>Context</span></a></li>
|
|
291
|
-
<li><a href="../interfaces/api.Operation.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Operation</span></a></li>
|
|
292
|
-
<li><a href="../interfaces/api.OperationWithRequestBody.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg><span>Operation<wbr/>With<wbr/>Request<wbr/>Body</span></a></li>
|
|
293
|
-
<li><a href="../types/api.APIGatewayv1Handler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg><span>APIGatewayv1<wbr/>Handler</span></a></li>
|
|
294
|
-
<li><a href="../types/api.AppSyncHandler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>App<wbr/>Sync<wbr/>Handler</span></a></li>
|
|
295
|
-
<li><a href="../types/api.HttpHandler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg><span>Http<wbr/>Handler</span></a></li>
|
|
296
|
-
<li><a href="../functions/api.createAppSyncHandler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg><span>create<wbr/>App<wbr/>Sync<wbr/>Handler</span></a></li>
|
|
297
|
-
<li><a href="../functions/api.createHttpHandler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>create<wbr/>Http<wbr/>Handler</span></a></li>
|
|
298
|
-
<li><a href="../functions/api.createOpenApiHandler.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler</span></a></li>
|
|
299
|
-
<li><a href="../functions/api.createOpenApiHandlerWithRequestBody.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body</span></a></li>
|
|
300
|
-
<li><a href="../functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body<wbr/>No<wbr/>Response</span></a></li></ul></div></details></li>
|
|
301
|
-
<li>
|
|
302
|
-
<details class="tsd-index-accordion" open data-key="auth"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/auth.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>auth</span></a></summary>
|
|
303
|
-
<div class="tsd-accordion-details">
|
|
304
|
-
<ul class="tsd-nested-navigation">
|
|
305
|
-
<li><a href="auth.ApiGatewayv1CognitoAuthorizer.html" class="current"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Api<wbr/>Gatewayv1<wbr/>Cognito<wbr/>Authorizer</span></a></li>
|
|
306
|
-
<li><a href="auth.ApiGatewayv1JwtAuthorizer.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Api<wbr/>Gatewayv1<wbr/>Jwt<wbr/>Authorizer</span></a></li>
|
|
307
|
-
<li><a href="auth.ApiGatewayv2CognitoAuthorizer.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Api<wbr/>Gatewayv2<wbr/>Cognito<wbr/>Authorizer</span></a></li>
|
|
308
|
-
<li><a href="auth.ApiGatewayv2JwtAuthorizer.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Api<wbr/>Gatewayv2<wbr/>Jwt<wbr/>Authorizer</span></a></li>
|
|
309
|
-
<li><a href="auth.AppSyncCognitoAuthorizer.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>App<wbr/>Sync<wbr/>Cognito<wbr/>Authorizer</span></a></li>
|
|
310
|
-
<li><a href="auth.CognitoAuthorizer.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Cognito<wbr/>Authorizer</span></a></li>
|
|
311
|
-
<li><a href="auth.JwtAuthorizer.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg><span>Jwt<wbr/>Authorizer</span></a></li></ul></div></details></li>
|
|
312
|
-
<li>
|
|
313
|
-
<details class="tsd-index-accordion" data-key="errors"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg><a href="../modules/errors.html"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4-path"></use><use href="#icon-4-text"></use></svg><span>errors</span></a></summary>
|
|
303
|
+
<details class="tsd-index-accordion" open data-key="auth"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><a href="../modules/auth.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>auth</span></a></summary>
|
|
314
304
|
<div class="tsd-accordion-details">
|
|
315
305
|
<ul class="tsd-nested-navigation">
|
|
316
|
-
<li><a href="
|
|
317
|
-
<li><a href="
|
|
318
|
-
<li><a href="
|
|
319
|
-
<li><a href="
|
|
320
|
-
<li><a href="
|
|
306
|
+
<li><a href="auth.ApiGatewayv1CognitoAuthorizer.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Api<wbr/>Gatewayv1<wbr/>Cognito<wbr/>Authorizer</span></a></li>
|
|
307
|
+
<li><a href="auth.ApiGatewayv1JwtAuthorizer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Api<wbr/>Gatewayv1<wbr/>Jwt<wbr/>Authorizer</span></a></li>
|
|
308
|
+
<li><a href="auth.ApiGatewayv2CognitoAuthorizer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Api<wbr/>Gatewayv2<wbr/>Cognito<wbr/>Authorizer</span></a></li>
|
|
309
|
+
<li><a href="auth.ApiGatewayv2JwtAuthorizer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Api<wbr/>Gatewayv2<wbr/>Jwt<wbr/>Authorizer</span></a></li>
|
|
310
|
+
<li><a href="auth.AppSyncCognitoAuthorizer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>App<wbr/>Sync<wbr/>Cognito<wbr/>Authorizer</span></a></li>
|
|
311
|
+
<li><a href="auth.CognitoAuthorizer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cognito<wbr/>Authorizer</span></a></li>
|
|
312
|
+
<li><a href="auth.JwtAuthorizer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Jwt<wbr/>Authorizer</span></a></li></ul></div></details></li>
|
|
313
|
+
<li><a href="../modules/errors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>errors</span></a></li></ul></nav></div></div></div>
|
|
321
314
|
<div class="tsd-generator">
|
|
322
315
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
|
|
323
316
|
<div class="overlay"></div></body></html>
|