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 |
| import-api | import_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_IMPORT_API_REST_USERNAME | import_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 |