API credentials

APIs roles

Different APIs require different roles for access.

Following table presents which roles is required to access each API:

API name Required role
configuration-api configuration_rest
credentials-api credentials_rest
events-api events_rest
person-api persons_rest
session-api session_rest
statistics-api statistics_rest
storage-api storage_rest

Users roles

Each user has a set of predefined roles.

Following table presents which role is assigned to each user:

Username defined by environment variable Roles
IDP_​CONFIGURATION_​API_​REST_​USERNAME configuration_rest
IDP_​CREDENTIALS_​API_​REST_​USERNAME credentials_rest
IDP_​EVENTS_​API_​REST_​USERNAME events_rest
IDP_​PERSONS_​API_​REST_​USERNAME persons_rest
IDP_​STATISTICS_​API_​REST_​USERNAME statistics_rest
IDP_​API_​REST_​USERNAME defined in the IDP_API_REST_USER_ROLES environment variable, by default this user has all roles