Services surrounding KeyCloak, that use the REST API to read/update state
Project description
keycloak-rest-services
Services surrounding Keycloak, that use the REST API to read/update state.
Running Tests
The tests run automatically in CircleCI, but for those that want to run them locally, there is a way.
First, build and load the local python environment:
./setupenv.sh
. env/bin/activate
Then, start instances of Keycloak, LDAP, and RabbitMQ in other terminals:
./resources/start-keycloak.sh
./resources/start-ldap.sh
./resources/start-rabbitmq.sh
Keycloak may take a minute to start. If it does not, check your network settings, as it does not play well with VPNs and other more exotic network situations.
Finally, run the tests:
source ./resources/pytest-env.sh
pytest
Getting Test Coverage
If you want a coverage report, instead of running pytest directly, run it under the coverage tool:
keycloak_url=http://localhost:8080 username=admin password=admin coverage run -m pytest
coverage html --include='krs*'
Manually Running Scripts
It is possible to manually run all of the basic operations for controlling users and groups.
-
Bootstrap Keycloak
If you do not already have a Keycloak instance, start a test instance as shown above. Then, run the bootstrap script to create a realm and the REST service account:
keycloak_url=http://localhost:8080 username=admin password=admin realm=test python3 -m krs.bootstrap
Save the
client_secret
that gets printed, as you will need this. -
User and group actions
Now you can actually run the scripts, which take the format:
keycloak_url=http://localhost:8080 client_id=rest-access client_secret=<SECRET> realm=test python -m krs.<SCRIPT> <ARGS>
As an example, to list all groups:
keycloak_url=http://localhost:8080 client_id=rest-access client_secret=<SECRET> realm=test python -m krs.groups list
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.
Source Distribution
Built Distribution
Hashes for wipac-keycloak-rest-services-1.4.20.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f2cc41bead7a1594c27cdb082c8ca810a25ce6fc701cd365b7403e6ecde5775 |
|
MD5 | 07f49f51c65c8f6fd809a01ac8d7c064 |
|
BLAKE2b-256 | 61ee419ab9a7cee4c216573f5e704481097e3440933b8114834ce1b90552ad13 |
Hashes for wipac_keycloak_rest_services-1.4.20-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 432e58171e09c4a503b1ec8d2ab758b38d8ac64335a6d1fc9872427b8d012a8f |
|
MD5 | 2728703363f66b24f20e2173565cd937 |
|
BLAKE2b-256 | e6b55d2c36181f779f5e563e599c4447fb0459f5533397d2baf87d0063a7095c |