Git Product home page Git Product logo

koa-serverless-auth's Introduction

Koa-serverless-auth

Koa middleware for adding auth state from API Gateway. This library assumes that the request has already been parsed via another library, e.g. serverless-http.

Currently the only supported gateways are the AWS ones.

Options

Name Type Default Description
bindTo String auth Context state key to store the auth object against
errors Object Error messages
errors.?.code Number HTTP status code
errors.?.message String Response message
localEnv Boolean true Apply fake user data if NODE_ENV is local
fakeUser Object { userId: '000000000', name: 'Example User' } Fake auth object that will be applied if runing in local env

Errors

Name Default Code Default Message Description
authorizer 401 Authorizer not present Authorizer keys were not present in the request
claims 401 Missing authorizer claims oAuth claims failed to parse

Authorizers

Firebase

Firebase key Koa key Type Description
claims.userId id String Users identifier
claims.name name String Users name
scopes scopes Object (optional) oAuth scopes

koa-serverless-auth's People

Contributors

deltabyte avatar

Watchers

James Cloos avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.