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.19.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e5f707fc848b39bb609f6ad3dcb4ecfae17dbc2491c5a9cc3bc6f2796e67d8c |
|
MD5 | 9396357db408fda653914b1fdbd564f8 |
|
BLAKE2b-256 | 3e977cf843e05d8023b25e61731afb04dca19bd013b95d4f2e77db180d511736 |
Hashes for wipac_keycloak_rest_services-1.4.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7561638fddc8bacfcdd530327ff029745fa9150e829b909bda7dad0f096db84 |
|
MD5 | 43201f5b3cdc599eb24a4a513b996edd |
|
BLAKE2b-256 | 5ec557ba09cdc8fde4d3cb089399254bf9e9ca13fb95a6982bafd5556fc36c83 |