What is it?

A sample Resource API with CRUD ops protected by JWT scopes (access_token) & postgres backend The domain object (account) corresponds to a typical Auth0 Custom DB table and this API can therefore act as a webservice fronting Postgres for Custom DB HTTP endpoint access (from Rules, Custom DB Scripts or other webtasks).

Companion Repos

• auth0-react-redux-api-client
• https://github.com/tawawa/auth0-github-source-control

Running locally

To run the sample extension locally:

Rename .env.sample as .env and add the required values for each key value pair.

$ npm install
$ npm start

Alternatively, just do node server.js - useful for running in debug mode etc

Then go to http://localhost:3001/api/v1/accounts

To use as Custom DB

The endpoints include the REST endpoints to handle account management & custom signup requirements from within an application - see companion React-Redux project for insights on a UI layer to this API.

However, this project also includes endpoints for integration with the Auth0 Custom DB scripts. To run the API locally yet have it called from Auth0 Dashboard scripts, use ngrok to expose your locally running instance over the internet.

Install ngrok using npm i ngrok -g

To expose the running application over internet use:

ngrok http 3001 -bind-tls=false

Now use the generated endpoints in configuration.ENDPOINT etc of your custom db scripts.

Postgres Relational DB

This uses a very simple, single postgres table. Details as follows The table will be automatically generated when you run:

npm run createDB

or

node createDB.js

Please ensure you supplied the correct DB connection settings in .env first

Sample .env populated:

AUTH0_ISSUER=https://demo.auth0.com/
AUTH0_AUDIENCE=https://resourceapi.com
POSTGRES_DATABASE=mypostgresdb
POSTGRES_HOST=arcseldon-postgres-db.adfadfadfadf.ap-northeast-1.rds.amazonaws.com
POSTGRES_USERNAME=YOUR_USER
POSTGRES_PASSWORD=YOUR_PASSWORD
# ALLOWED_IP_LIST=::ffff:127.0.0.1
# ALLOWED_IP_LIST=127.0.0.1
ALLOWED_IP_LIST=138.91.154.99,54.221.228.15,54.183.64.135,54.67.77.38,54.67.15.170,54.183.204.205,54.173.21.107,54.85.173.28,127.0.0.1

Use .env.sample as a starting point if you like

Using Postman

Since this is a headless API, there is a Postman collection should you wish to use this tool to test the endpoints.

See the postman directory in base of project and you can import the collection it contains using the postman import feature.

Deploying as Webtask

TODO - not yet working... (dependencies issue on webtask side - code is good)

Rename .env.sample as .env and add the required values for each key value pair.

$ ./deploy 

Then go to your webtask URL endpoint + /api/v1/accounts

What is Auth0?

Auth0 helps you to:

• Add authentication with multiple authentication sources, either social like Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce, among others, or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS or any SAML Identity Provider.
• Add authentication through more traditional username/password databases.
• Add support for linking different user accounts with the same user.
• Support for generating signed Json Web Tokens to call your APIs and flow the user identity securely.
• Analytics of how, when and where users are logging in.
• Pull data from other sources and add it to the user profile, through JavaScript rules.

Create a free Auth0 Account

1. Go to Auth0 and click Sign Up.
2. Use Google, GitHub or Microsoft Account to login.

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.