You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
118 lines
3.1 KiB
118 lines
3.1 KiB
.. python-keycloak documentation master file, created by
|
|
sphinx-quickstart on Tue Aug 15 11:02:59 2017.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|
|
.. image:: https://readthedocs.org/projects/python-keycloak/badge/?version=latest
|
|
:target: http://python-keycloak.readthedocs.io/en/latest/?badge=latest
|
|
|
|
|
|
Welcome to python-keycloak's documentation!
|
|
===========================================
|
|
|
|
**python-keycloak** is a Python package providing access to the Keycloak API.
|
|
|
|
Installation
|
|
==================
|
|
|
|
Via Pypi Package::
|
|
|
|
$ pip install python-keycloak
|
|
|
|
Manually::
|
|
|
|
$ python setup.py install
|
|
|
|
Dependencies
|
|
==================
|
|
|
|
python-keycloak depends on:
|
|
|
|
* Python 3
|
|
* `requests <http://docs.python-requests.org/en/master/>`_
|
|
* `python-jose <http://python-jose.readthedocs.io/en/latest/>`_
|
|
|
|
Tests Dependencies
|
|
------------------
|
|
|
|
* unittest
|
|
* `httmock <https://github.com/patrys/httmock>`_
|
|
|
|
Bug reports
|
|
==================
|
|
|
|
Please report bugs and feature requests at
|
|
`https://bitbucket.org/agriness/python-keycloak/issues <https://bitbucket.org/agriness/python-keycloak/issues>`_
|
|
|
|
Documentation
|
|
==================
|
|
|
|
The documentation for python-keycloak is available on `readthedocs <http://python-keycloak.readthedocs.io>`_.
|
|
|
|
Contributors
|
|
==================
|
|
|
|
* `Agriness Team <http://www.agriness.com/pt/>`_
|
|
|
|
Usage
|
|
=====
|
|
|
|
Main methods::
|
|
|
|
from keycloak import Keycloak
|
|
|
|
# Configure client
|
|
keycloak = Keycloak(server_url="http://localhost:8080/auth/",
|
|
client_id="example_client",
|
|
realm_name="example_realm",
|
|
client_secret_key="secret")
|
|
|
|
# Get WellKnow
|
|
config_well_know = keycloak.well_know()
|
|
|
|
# Get Token
|
|
token = keycloak.token("user", "password")
|
|
|
|
# Get Userinfo
|
|
userinfo = keycloak.userinfo(token['access_token'])
|
|
|
|
# Logout
|
|
keycloak.logout(token['refresh_token'])
|
|
|
|
# Get Certs
|
|
certs = keycloak.certs()
|
|
|
|
# Get RPT (Entitlement)
|
|
token = keycloak.token("user", "password")
|
|
rpt = keycloak.entitlement(token['access_token'], "resource_id")
|
|
|
|
# Instropect RPT
|
|
token_rpt_info = keycloak.instropect(keycloak.instropect(token['access_token'], rpt=rpt['rpt'],
|
|
token_type_hint="requesting_party_token"))
|
|
|
|
# Introspect Token
|
|
token_info = keycloak.introspect(token['access_token']))
|
|
|
|
# Decode Token
|
|
KEYCLOAK_PUBLIC_KEY = "secret"
|
|
options = {"verify_signature": True, "verify_aud": True, "exp": True}
|
|
token_info = keycloak.decode_token(token['access_token'], key=KEYCLOAK_PUBLIC_KEY, options=options)
|
|
|
|
# Get permissions by token
|
|
token = keycloak.token("user", "password")
|
|
keycloak.load_authorization_config("example-authz-config.json")
|
|
policies = keycloak.get_policies(token['access_token'], method_token_info='decode', key=KEYCLOAK_PUBLIC_KEY)
|
|
permissions = keycloak.get_permissions(token['access_token'], method_token_info='introspect')
|
|
|