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.74.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e1d964dd313ffb2a4651cd18fd5bbbf900579422a92f7679479205c946661357 |
|
MD5 | fa4bc4df515e9d5173dee7e666f09882 |
|
BLAKE2b-256 | 1beb23190b4a8e3a969d58529d55f2d5c6d2d7ccaa06a99cc05d1e0e239f7d00 |
Hashes for wipac_keycloak_rest_services-1.4.74-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2561c8165cc3c76dec28bfa70faf13c9edae3c413c7182fb3b3194d243511144 |
|
MD5 | e830f20607d9331958acca1e6e904b16 |
|
BLAKE2b-256 | c6b2d944a8b1fe4b1d6047ace1074bfeceb8d05c06a4d988d61987700d218110 |