iam

Identity and access management

Endpoints

• Admin UI: /admin
• OpenAPI JSON: /openapi.json
• API docs: See https://docs.dd-decaf.eu

Development

Type make to see frequently used workflow commands.

Setup

A local keypair for token signing must be generated, and the databases must be created and migrated. This can be done by running make setup.

Testing

To run all tests and QA checks, run make qa.

Environment

Specify environment variables in a .env file. See docker-compose.yml for the possible variables and their default values.

• ENVIRONMENT Set to either development, testing, staging or production.
• SECRET_KEY Flask secret key. Will be randomly generated in development and testing environments.
• SENTRY_DSN DSN for reporting exceptions to Sentry.
• ALLOWED_ORIGINS Comma-seperated list of CORS allowed origins.
• BASIC_AUTH_USERNAME Username to authenticate with admin interface
• BASIC_AUTH_PASSWORD Password to authenticate with admin interface
• FEAT_TOGGLE_LOCAL_AUTH Feature toggle: local user database authentication
• DB_HOST Database configuration
• DB_PORT
• DB_NAME
• DB_USERNAME
• DB_PASSWORD
• FEAT_TOGGLE_FIREBASE: Feature toggle: firebase authentication
• FIREBASE_CLIENT_CERT_URL
• FIREBASE_CLIENT_EMAIL
• FIREBASE_CLIENT_ID
• FIREBASE_PRIVATE_KEY
• FIREBASE_PRIVATE_KEY_ID
• FIREBASE_PROJECT_ID

Updating Python dependencies

To compile a new requirements file and then re-build the service with the new requirements, run:

make pip-compile build