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.

251 lines
8.3 KiB

7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
6 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
6 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
6 years ago
7 years ago
6 years ago
  1. .. python-keycloak documentation master file, created by
  2. sphinx-quickstart on Tue Aug 15 11:02:59 2017.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. .. toctree::
  6. :maxdepth: 2
  7. :caption: Contents:
  8. Indices and tables
  9. ==================
  10. * :ref:`genindex`
  11. * :ref:`modindex`
  12. * :ref:`search`
  13. .. image:: https://readthedocs.org/projects/python-keycloak/badge/?version=latest
  14. :target: http://python-keycloak.readthedocs.io/en/latest/?badge=latest
  15. Welcome to python-keycloak's documentation!
  16. ===========================================
  17. **python-keycloak** is a Python package providing access to the Keycloak API.
  18. Installation
  19. ==================
  20. Via Pypi Package::
  21. $ pip install python-keycloak
  22. Manually::
  23. $ python setup.py install
  24. Dependencies
  25. ==================
  26. python-keycloak depends on:
  27. * Python 3
  28. * `requests <http://docs.python-requests.org/en/master/>`_
  29. * `python-jose <http://python-jose.readthedocs.io/en/latest/>`_
  30. Tests Dependencies
  31. ------------------
  32. * unittest
  33. * `httmock <https://github.com/patrys/httmock>`_
  34. Bug reports
  35. ==================
  36. Please report bugs and feature requests at
  37. `https://bitbucket.org/agriness/python-keycloak/issues <https://bitbucket.org/agriness/python-keycloak/issues>`_
  38. Documentation
  39. ==================
  40. The documentation for python-keycloak is available on `readthedocs <http://python-keycloak.readthedocs.io>`_.
  41. Contributors
  42. ==================
  43. * `Agriness Team <http://www.agriness.com/pt/>`_
  44. * `Marcos Pereira <marcospereira.mpj@gmail.com>`_
  45. * `Martin Devlin <martin.devlin@pearson.com>`_
  46. * `Shon T. Urbas <shon.urbas@gmail.com>`_
  47. * `Markus Spanier <https://bitbucket.org/spanierm/>`_
  48. * `Remco Kranenburg <https://bitbucket.org/Remco47/>`_
  49. * `Armin <https://bitbucket.org/arminfelder/>`_
  50. * `Njordr <https://bitbucket.org/njordr/>`_
  51. * `Josha Inglis <https://bitbucket.org/joshainglis/>`_
  52. * `Alex <https://bitbucket.org/alex_zel/>`_
  53. * `Ewan Jone <https://bitbucket.org/kisamoto/>`_
  54. Usage
  55. =====
  56. Main methods::
  57. # KEYCLOAK OPENID
  58. from keycloak import KeycloakOpenID
  59. # Configure client
  60. keycloak_openid = KeycloakOpenID(server_url="http://localhost:8080/auth/",
  61. client_id="example_client",
  62. realm_name="example_realm",
  63. client_secret_key="secret",
  64. verify=True)
  65. # Get WellKnow
  66. config_well_know = keycloak_openid.well_know()
  67. # Get Token
  68. token = keycloak_openid.token("user", "password")
  69. token = keycloak_openid.token("user", "password", totp="012345")
  70. # Get Userinfo
  71. userinfo = keycloak_openid.userinfo(token['access_token'])
  72. # Refresh token
  73. token = keycloak_openid.refresh_token(token['refresh_token'])
  74. # Logout
  75. keycloak_openid.logout(token['refresh_token'])
  76. # Get Certs
  77. certs = keycloak_openid.certs()
  78. # Get RPT (Entitlement)
  79. token = keycloak_openid.token("user", "password")
  80. rpt = keycloak_openid.entitlement(token['access_token'], "resource_id")
  81. # Instropect RPT
  82. token_rpt_info = keycloak_openid.introspect(keycloak_openid.introspect(token['access_token'], rpt=rpt['rpt'],
  83. token_type_hint="requesting_party_token"))
  84. # Introspect Token
  85. token_info = keycloak_openid.introspect(token['access_token']))
  86. # Decode Token
  87. KEYCLOAK_PUBLIC_KEY = "secret"
  88. options = {"verify_signature": True, "verify_aud": True, "exp": True}
  89. token_info = keycloak_openid.decode_token(token['access_token'], key=KEYCLOAK_PUBLIC_KEY, options=options)
  90. # Get permissions by token
  91. token = keycloak_openid.token("user", "password")
  92. keycloak_openid.load_authorization_config("example-authz-config.json")
  93. policies = keycloak_openid.get_policies(token['access_token'], method_token_info='decode', key=KEYCLOAK_PUBLIC_KEY)
  94. permissions = keycloak_openid.get_permissions(token['access_token'], method_token_info='introspect')
  95. # KEYCLOAK ADMIN
  96. from keycloak import KeycloakAdmin
  97. keycloak_admin = KeycloakAdmin(server_url="http://localhost:8080/auth/",
  98. username='example-admin',
  99. password='secret',
  100. realm_name="example_realm",
  101. verify=True)
  102. # Add user
  103. new_user = keycloak_admin.create_user({"email": "example@example.com",
  104. "username": "example@example.com",
  105. "enabled": True,
  106. "firstName": "Example",
  107. "lastName": "Example",
  108. "realmRoles": ["user_default", ],
  109. "attributes": {"example": "1,2,3,3,"}})
  110. # Add user and set password
  111. new_user = keycloak_admin.create_user({"email": "example@example.com",
  112. "username": "example@example.com",
  113. "enabled": True,
  114. "firstName": "Example",
  115. "lastName": "Example",
  116. "credentials": [{"value": "secret","type": "password",}],
  117. "realmRoles": ["user_default", ],
  118. "attributes": {"example": "1,2,3,3,"}})
  119. # User counter
  120. count_users = keycloak_admin.users_count()
  121. # Get users Returns a list of users, filtered according to query parameters
  122. users = keycloak_admin.get_users({})
  123. # Get user ID from name
  124. user-id-keycloak = keycloak_admin.get_user_id("example@example.com")
  125. # Get User
  126. user = keycloak_admin.get_user("user-id-keycloak")
  127. # Update User
  128. response = keycloak_admin.update_user(user_id="user-id-keycloak",
  129. payload={'firstName': 'Example Update'})
  130. # Update User Password
  131. response = set_user_password(user_id="user-id-keycloak", password="secret", temporary=True)
  132. # Delete User
  133. response = keycloak_admin.delete_user(user_id="user-id-keycloak")
  134. # Get consents granted by the user
  135. consents = keycloak_admin.consents_user(user_id="user-id-keycloak")
  136. # Send User Action
  137. response = keycloak_admin.send_update_account(user_id="user-id-keycloak",
  138. payload=json.dumps(['UPDATE_PASSWORD']))
  139. # Send Verify Email
  140. response = keycloak_admin.send_verify_email(user_id="user-id-keycloak")
  141. # Get sessions associated with the user
  142. sessions = keycloak_admin.get_sessions(user_id="user-id-keycloak")
  143. # Get themes, social providers, auth providers, and event listeners available on this server
  144. server_info = keycloak_admin.get_server_info()
  145. # Get clients belonging to the realm Returns a list of clients belonging to the realm
  146. clients = keycloak_admin.get_clients()
  147. # Get client - id (not client-id) from client by name
  148. client_id=keycloak_admin.get_client_id("my-client")
  149. # Get representation of the client - id of client (not client-id)
  150. client = keycloak_admin.get_client(client_id="client_id")
  151. # Get all roles for the realm or client
  152. realm_roles = keycloak_admin.get_realm_roles()
  153. # Get all roles for the client
  154. client_roles = keycloak_admin.get_client_roles(client_id="client_id")
  155. # Get client role
  156. role = keycloak_admin.get_client_role(client_id="client_id", role_name="role_name")
  157. # Warning: Deprecated
  158. # Get client role id from name
  159. role_id = keycloak_admin.get_client_role_id(client_id="client_id", role_name="test")
  160. # Create client role
  161. keycloak_admin.create_client_role(client_id, "test")
  162. # Get client role id from name
  163. role_id = keycloak_admin.get_client_role_id(client_id=client_id, role_name="test")
  164. # Get all roles for the realm or client
  165. realm_roles = keycloak_admin.get_roles()
  166. # Assign client role to user. Note that BOTH role_name and role_id appear to be required.
  167. keycloak_admin.assign_client_role(client_id="client_id", user_id="user_id", role_id="role_id", role_name="test")
  168. # Create new group
  169. group = keycloak_admin.create_group(name="Example Group")
  170. # Get all groups
  171. groups = keycloak_admin.get_groups()
  172. # Get group
  173. group = keycloak_admin.get_group(group_id='group_id')
  174. # Get group by path
  175. group = keycloak_admin.get_group_by_path(path='/group/subgroup', search_in_subgroups=True)
  176. # Function to trigger user sync from provider
  177. sync_users(storage_id="storage_di", action="action")