Home

OCARIoT Account Microservice API

This is the service responsible for generating and managing the credentials of OCARIoT users. The account service defines permissions for users with different roles in the OCARIoT platform and generates access tokens that shall be used for accessing the OCARIoT resources.

Getting started

This documentation describes all possible responses for all routes available on this service, with different response types and errors separated by feature.

Visit auth to understand a little about the authentication mechanism and how to use it.

User scopes

The scopes of each user are detailed here.

Most of the routes have some permission details that were implemented through authorization policies in the API Gateway, these details are explained (and highlighted in bold) in 'description' section of each route.

Query string support

GET ALL routes support the use of query strings, and use this middleware to transform them into a format recognized by MongoDB (database used in this microservice), MySQL, and other databases.

For more details go to the Query Strings section.