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 an instance of Keycloak in another terminal:
docker run --rm -it -p 8080:8080 -e KEYCLOAK_USER=admin -e KEYCLOAK_PASSWORD=admin quay.io/keycloak/keycloak:latest -Djboss.bind.address.private=127.0.0.1 -Djboss.bind.address=0.0.0.0
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:
keycloak_url=http://localhost:8080 username=admin password=admin 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.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97aea5e8127f09eadfabb0f951c2cf27b9060256887e4286611310b7075866f0 |
|
MD5 | 7cfc79b0b531f6d6af2bed8ce81a3099 |
|
BLAKE2b-256 | 5396b54863ecca9a637be19b952e610ff73909b2285c670721dfcf48fada29f9 |
Hashes for wipac_keycloak_rest_services-1.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a431453d54c4d5ed672de42532c08530578ae4e0ab7bd4aa6ba76f1d728e8e7c |
|
MD5 | 6e0628f1221e1760e68125412964573d |
|
BLAKE2b-256 | 4f3d7fef9b1eba60ec95bb7ec936fb69f7ecc20ccfd222b9132d9ddae74da19c |