A Django app that handles the communication between the IDP and the products for the authorization of users.
Project description
Quick start
Add “idp_user” to your INSTALLED_APPS setting like this:
INSTALLED_APPS = [ ... 'idp_user', ]
Add the settings of the app in settings.py like this:
APP_ENV = "development"/"staging"/"production" AUTH_USER_MODEL = 'idp_user.User' IDP_USER_APP = { "APP_IDENTIFIER": "str", "ROLES": "path.to.roles_choices", "FAUST_APP_PATH": "backend.kafka_consumer.app", "USE_REDIS_CACHE": True, "IDP_URL": "idp_url", # Optional "APP_ENTITIES": { "<entity_type>": { "model": "<path.to.entity_type.model>", "identifier_attr": "<field_name>", "label_attr": "<field_name>", } }, "CONSUMER_APP_ENV": (Optional) "development"/"staging"/"production", } REST_FRAMEWORK = { 'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema' / 'idp_user.schema_extensions.AutoSchemaWithRole', 'DEFAULT_AUTHENTICATION_CLASSES': ( 'idp_user.auth.AuthenticationBackend', ), } SPECTACULAR_SETTINGS = { 'DEFAULT_AUTHENTICATION_CLASSES': ( 'idp_user.schema_extensions.BearerTokenScheme', ), 'SERVE_AUTHENTICATION': () } # Kafka Related KAFKA_ARN = "<aws_kafka_arn>" # Encoded in base64 KAFKA_AWS_ACCESS_KEY_ID = "<access_key_id>" KAFKA_AWS_SECRET_ACCESS_KEY = "<secret_access_key_id>" # Encoded in base64 AWS_S3_REGION_NAME = "<region_name>"
Run python manage.py migrate to create the models.
Settings Reference
APP_IDENTIFIER
The app identifier, as defined in the IDP.
ROLES
The path to the roles choices.
FAUST_APP_PATH
The path to the Faust app.
IDP_URL
The URL of the IDP, used for local development, or when using the IDP as an Authentication Backend.
USE_REDIS_CACHE
If True, the cache will be used
When developing locally, you can leave this as False.
APP_ENTITIES
This dict links the AppEntityTypes declared on the IDP for this app to their actual models, so that they can be used for authorization purposes. In the value dicts, the attributes that will be used as the identifier and label are declared as well.
CONSUMER_APP_ENV
The environment of the Faust Kafka Consumer app.
If not set, the value of APP_ENV will be used.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.