Skip to content

Users available on the platform

Jefferson Medeiros edited this page Apr 23, 2020 · 4 revisions

Introduction

There are six user types defined in the context of OCARIoT, they are: Admin, Application, Child, Educator, Family and Health Professional. Below you will be given more details about the scope each of these has about each feature available on the platform.

Admin

Resource Scope
users users:delete, users:resetPassword
educators educators:create, educators:read, educators:readAll, educators:update, educators:delete
families families:create, families:read, families:readAll, families:update, families:delete
children children:create, children:read, children:readAll, children:update, children:delete
healthprofessionals healthprofessionals:create, healthprofessionals:read, healthprofessionals:readAll, healthprofessionals:update, healthprofessionals:delete
applications applications:create, applications:read, applications:readAll, applications:update, applications:delete
institutions institutions:create, institutions:read, institutions:readAll, institutions:update, institutions:delete
socioquest socioquest:read
healthquest healthquest:read
parentphyquest parentphyquest:read
childrenphyquest childrenphyquest:read
habitsquest habitsquest:read
foodhabitsquest foodhabitsquest:read
perceptionquest perceptionquest:read
foodtracking foodtracking:create, foodtracking:read, foodtracking:update, foodtracking:delete
physicalactivities physicalactivities:read
sleep sleep:read
measurements measurements:read
environment environment:read
missions missions:read
gamificationprofile gamificationprofile:read
notifications notifications:create, notifications:read, notifications:delete

Application

Resource Scope
applications applications:read
children children:readAll
institutions institutions:read, institutions:readAll
physicalactivities physicalactivities:create, physicalactivities:read, physicalactivities:update, physicalactivities:delete
sleep sleep:create, sleep:read, sleep:update, sleep:delete
measurements measurements:create, measurements:read, measurements:delete
environment environment:create, environment:read, environment:update, environment:delete
socioquest socioquest:read
healthquest healthquest:read
parentphyquest parentphyquest:read
childrenphyquest childrenphyquest:read
habitsquest habitsquest:read
foodhabitsquest foodhabitsquest:create, foodhabitsquest:read
perceptionquest perceptionquest:read
foodtracking foodtracking:create, foodtracking:read, foodtracking:update, foodtracking:delete
missions missions:create, missions:read, missions:update, missions:delete
gamificationprofile gamificationprofile:create, gamificationprofile:read, gamificationprofile:update, gamificationprofile:delete
external external:sync

Child

Resource Scope
children children:read
institutions institutions:read
physicalactivities physicalactivities:create, physicalactivities:read
sleep sleep:create, sleep:read
measurements measurements:create, measurements:read
environment environment:read
foodtracking foodtracking:create, foodtracking:read, foodtracking:update, foodtracking:delete
missions missions:read
gamificationprofile gamificationprofile:read, gamificationprofile:update
external external:sync
notifications notifications:create, notifications:read, notifications:delete

Educator

Resource Scope
children children:read, children:readAll
educators educators:read, educators:update
childrengroups childrengroups:create, childrengroups:read, childrengroups:update, childrengroups:delete
institutions institutions:read, institutions:readAll, institutions:update
physicalactivities physicalactivities:create, physicalactivities:read, physicalactivities:update, physicalactivities:delete
sleep sleep:create, sleep:read, sleep:update, sleep:delete
measurements measurements:create, measurements:read, measurements:delete
environment environment:read
childrenphyquest childrenphyquest:read
habitsquest habitsquest:create, habitsquest:read, habitsquest:update
foodhabitsquest foodhabitsquest:create, foodhabitsquest:read, foodhabitsquest:update
perceptionquest perceptionquest:create, perceptionquest:read, perceptionquest:update
foodtracking foodtracking:create, foodtracking:read, foodtracking:update, foodtracking:delete
missions missions:create, missions:read, missions:update, missions:delete
gamificationprofile gamificationprofile:create gamificationprofile:read gamificationprofile:update
external external:sync
notifications notifications:create, notifications:read, notifications:delete

Family

Resource Scope
children children:read
families families:read, families:update
institutions institutions:read
physicalactivities physicalactivities:create, physicalactivities:read, physicalactivities:update, physicalactivities:delete
sleep sleep:create, sleep:read, sleep:update, sleep:delete
measurements measurements:create, measurements:read, measurements:delete
environment environment:read
socioquest socioquest:create, socioquest:read, socioquest:update
healthquest healthquest:create, healthquest:read, healthquest:update
parentphyquest parentphyquest:create, parentphyquest:read, parentphyquest:update
childrenphyquest childrenphyquest:read
habitsquest habitsquest:create, habitsquest:read, habitsquest:update
foodhabitsquest foodhabitsquest:create, foodhabitsquest:read, foodhabitsquest:update
perceptionquest perceptionquest:create, perceptionquest:read, perceptionquest:update
foodtracking foodtracking:create, foodtracking:read, foodtracking:update, foodtracking:delete
missions missions:create missions:read missions:update
gamificationprofile gamificationprofile:create gamificationprofile:read gamificationprofile:update
external external:sync
notifications notifications:create, notifications:read, notifications:delete

Health Professional

Resource Scope
children children:read, children:readAll
healthprofessionals healthprofessionals:read, healthprofessionals:update
childrengroups childrengroups:create, childrengroups:read, childrengroups:update, childrengroups:delete
institutions institutions:read, institutions:readAll, institutions:update
physicalactivities physicalactivities:read
sleep sleep:read
measurements measurements:read
environment environment:read
socioquest socioquest:read
healthquest healthquest:read
parentphyquest parentphyquest:read
childrenphyquest childrenphyquest:create, childrenphyquest:read, childrenphyquest:update
habitsquest habitsquest:read
foodhabitsquest foodhabitsquest:read
perceptionquest perceptionquest:read
foodtracking foodtracking:create, foodtracking:read, foodtracking:update, foodtracking:delete
missions missions:read
gamificationprofile gamificationprofile:read
external external:sync
notifications notifications:create, notifications:read, notifications:delete

OCARIoT users

Integration endpoints

auth

users

institutions

children

children.physicalactivities

children.logs

children.sleep

children.weights

children.bodyfats

educators

educators.children.groups

families

families.children

healthprofessionals

healthprofessionals.children.groups

applications

institutions.environments

fitbit

fitbit.subscriber

users.fitbit.auth

users.fitbit.sync

Error patterns

400 Validation Errors

Clone this wiki locally