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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5d6c95df7881e9f2cdd52029aee3dca74ec2abcfadac232cb3b798ce5d310ce |
|
MD5 | 1c32054cf164ab2622f50eb1641d4054 |
|
BLAKE2b-256 | e8795552fe9637f70b432ff1d796866f695f2897d2839436438fcaeb16ed0533 |
Hashes for wipac_keycloak_rest_services-1.2.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3cb56ad8095d05d5327d643015c24f98c0e904f1aaa1c445c4fc28cb57ed8108 |
|
MD5 | 37b75e6841a72c2597883493446977b8 |
|
BLAKE2b-256 | b2c78c34a0d86f415f19eee2c486a4691e40f9601e7b75e3e421b3edf085e481 |