@nearform/udaru-hapi-server

Hapi server that uses udaru for policy based authorization

Usage no npm install needed!

<script type="module">
  import nearformUdaruHapiServer from 'https://cdn.skypack.dev/@nearform/udaru-hapi-server';
</script>

README

Hapi Udaru Server

npm travis coveralls snyk

Udaru is a Policy Based Access Control (PBAC) authorization module. It supports Organizations, Teams and User entities that are used to build the access model. The policies attached to these entities define the 'Actions' that can be performed by an entity on various 'Resources'.

See the Udaru website for complete documentation on Udaru.

Install

To install via npm:

npm install @nearform/udaru-hapi-server

Usage

npm run start

Documentation

The Udaru documentation site can be found at nearform.github.io/udaru.

Swagger API Documentation

The Swagger API documentation gives explanations on the exposed API. The documentation can be found at nearform.github.io/udaru/swagger/.

It is also possible to access the Swagger documentation from Udaru itself. Simply start the server:

npm run start

and then go to http://localhost:8080/documentation

The Swagger documentation also gives the ability to execute calls to the API and see their results. If you're using the test database, you can use 'ROOTid' as the required authorization parameter and 'WONKA' as the organisation.

License

Copyright nearForm Ltd 2017. Licensed under MIT.