@webiny/api-security-okta

@webiny/api-security-cognito

A plugin that enables Amazon Cognito based authentication in @webiny/handler handlers.

Install

npm install --save @webiny/api-security @webiny/api-security-cognito

Or if you prefer yarn:

yarn add @webiny/api-security @webiny/api-security-cognito

Quick Example

The set up process consists only of a single step, and that's adding the plugins in your handler:

import { createHandler } from "@webiny/handler-aws";
import graphqlPlugins from "@webiny/handler-graphql";
import logsPlugins from "@webiny/handler-logs";
import securityPlugins, { SecurityIdentity } from "@webiny/api-security";
import cognitoAuthenticationPlugins from "@webiny/api-security-cognito";

// Imports plugins created via scaffolding utilities.
import scaffoldsPlugins from "./plugins/scaffolds";

const debug = process.env.DEBUG === "true";

export const handler = createHandler({
  plugins: [
    securityPlugins(),
    cognitoAuthenticationPlugins({
      region: process.env.COGNITO_REGION,
      userPoolId: process.env.COGNITO_USER_POOL_ID,
      identityType: "user"
    }),
    logsPlugins(),
    graphqlPlugins({ debug }),
    scaffoldsPlugins()
  ],
  http: { debug }
});

With all the plugins in place, you should be able to retrieve the current identity in your handler application code, via the context.security object:

const identity = context.security.getIdentity();

Changelog

5.18.0-beta.4 (2021-11-23)

Bug Fixes

• api-cognito-authenticator: make sure token is a string (bfa4422)
• api-security: handle parallel calls to getPermissions (170418d)
• api-security: use storage operations in authn/authz plugins (b123cf3)
• api-security-okta: make sure token is a string (dc96794)
• add TS ignore (12129a5)
• change port to 3002 (fcf755d)
• exit if no packages detected (f3bb8c7)
• improve error logging (59b5023)
• improve error logging (eed9759)
• remove extra "s" (848b331)
• remove PORT env variable (d08b03b)
• remove unused variables (558fbb8)
• temporarily disable the new "Action" page element (c20d44b)
• use correct functions (b987fe4)
• use output.log (f4662a0)
• api-prerendering-service: remove storageOperations from db record (0b7d497)