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.

207 lines
6.8 KiB

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
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
  1. [![Documentation Status](https://readthedocs.org/projects/python-keycloak/badge/?version=latest)](http://python-keycloak.readthedocs.io/en/latest/?badge=latest)
  2. Python Keycloak
  3. ====================
  4. For review- see https://bitbucket.org/agriness/python-keycloak
  5. **python-keycloak** is a Python package providing access to the Keycloak API.
  6. ## Installation
  7. ### Via Pypi Package:
  8. ``` $ pip install python-keycloak ```
  9. ### Manually
  10. ``` $ python setup.py install ```
  11. ## Dependencies
  12. python-keycloak depends on:
  13. * Python 3
  14. * [requests](http://docs.python-requests.org/en/master/)
  15. * [python-jose](http://python-jose.readthedocs.io/en/latest/)
  16. ### Tests Dependencies
  17. * unittest
  18. * [httmock](https://github.com/patrys/httmock)
  19. ## Bug reports
  20. Please report bugs and feature requests at
  21. https://bitbucket.org/agriness/python-keycloak/issues
  22. ## Documentation
  23. The documentation for python-keycloak is available on [readthedocs](http://python-keycloak.readthedocs.io).
  24. ## Contributors
  25. * [Agriness Team](http://www.agriness.com/pt/)
  26. * [Marcos Pereira](marcospereira.mpj@gmail.com)
  27. * [Martin Devlin](martin.devlin@pearson.com)
  28. * [Shon T. Urbas](shon.urbas@gmail.com>)
  29. ## Usage
  30. ```python
  31. from keycloak import KeycloakOpenID
  32. # Configure client
  33. keycloak_openid = KeycloakOpenID(server_url="http://localhost:8080/auth/",
  34. client_id="example_client",
  35. realm_name="example_realm",
  36. client_secret_key="secret")
  37. # Get WellKnow
  38. config_well_know = keycloak_openid.well_know()
  39. # Get Token
  40. token = keycloak_openid.token("user", "password")
  41. # Get Userinfo
  42. userinfo = keycloak_openid.userinfo(token['access_token'])
  43. # Refresh token
  44. token = keycloak_openid.refresh_token(token['refresh_token'])
  45. # Logout
  46. keycloak_openid.logout(token['refresh_token'])
  47. # Get Certs
  48. certs = keycloak_openid.certs()
  49. # Get RPT (Entitlement)
  50. token = keycloak_openid.token("user", "password")
  51. rpt = keycloak_openid.entitlement(token['access_token'], "resource_id")
  52. # Instropect RPT
  53. token_rpt_info = keycloak_openid.introspect(keycloak_openid.introspect(token['access_token'], rpt=rpt['rpt'],
  54. token_type_hint="requesting_party_token"))
  55. # Introspect Token
  56. token_info = keycloak_openid.introspect(token['access_token']))
  57. # Decode Token
  58. KEYCLOAK_PUBLIC_KEY = "secret"
  59. options = {"verify_signature": True, "verify_aud": True, "exp": True}
  60. token_info = keycloak_openid.decode_token(token['access_token'], key=KEYCLOAK_PUBLIC_KEY, options=options)
  61. # Get permissions by token
  62. token = keycloak_openid.token("user", "password")
  63. keycloak_openid.load_authorization_config("example-authz-config.json")
  64. policies = keycloak_openid.get_policies(token['access_token'], method_token_info='decode', key=KEYCLOAK_PUBLIC_KEY)
  65. permissions = keycloak_openid.get_permissions(token['access_token'], method_token_info='introspect')
  66. # KEYCLOAK ADMIN
  67. from keycloak import KeycloakAdmin
  68. keycloak_admin = KeycloakAdmin(server_url="http://localhost:8080/auth/",
  69. username='example-admin',
  70. password='secret',
  71. realm_name="example_realm",
  72. verify=True)
  73. # Add user
  74. new_user = keycloak_admin.create_user({"email": "example@example.com",
  75. "username": "example@example.com",
  76. "enabled": True,
  77. "firstName": "Example",
  78. "lastName": "Example",
  79. "realmRoles": ["user_default", ],
  80. "attributes": {"example": "1,2,3,3,"}})
  81. # Add user and set password
  82. new_user = keycloak_admin.create_user({"email": "example@example.com",
  83. "username": "example@example.com",
  84. "enabled": True,
  85. "firstName": "Example",
  86. "lastName": "Example",
  87. "credentials": [{"value": "secret","type": "password",}],
  88. "realmRoles": ["user_default", ],
  89. "attributes": {"example": "1,2,3,3,"}})
  90. # User counter
  91. count_users = keycloak_admin.users_count()
  92. # Get users Returns a list of users, filtered according to query parameters
  93. users = keycloak_admin.get_users({})
  94. # Get user ID from name
  95. user-id-keycloak = keycloak_admin.get_user_id("example@example.com")
  96. # Get User
  97. user = keycloak_admin.get_user("user-id-keycloak")
  98. # Update User
  99. response = keycloak_admin.update_user(user_id="user-id-keycloak",
  100. payload={'firstName': 'Example Update'})
  101. # Update User Password
  102. response = set_user_password(user_id="user-id-keycloak", password="secret", temporary=True)
  103. # Delete User
  104. response = keycloak_admin.delete_user(user_id="user-id-keycloak")
  105. # Get consents granted by the user
  106. consents = keycloak_admin.consents_user(user_id="user-id-keycloak")
  107. # Send User Action
  108. response = keycloak_admin.send_update_account(user_id="user-id-keycloak",
  109. payload=json.dumps(['UPDATE_PASSWORD']))
  110. # Send Verify Email
  111. response = keycloak_admin.send_verify_email(user_id="user-id-keycloak")
  112. # Get sessions associated with the user
  113. sessions = keycloak_admin.get_sessions(user_id="user-id-keycloak")
  114. # Get themes, social providers, auth providers, and event listeners available on this server
  115. server_info = keycloak_admin.get_server_info()
  116. # Get clients belonging to the realm Returns a list of clients belonging to the realm
  117. clients = keycloak_admin.get_clients()
  118. # Get client - id (not client-id) from client by name
  119. client_id=keycloak_admin.get_client_id("my-client")
  120. # Get representation of the client - id of client (not client-id)
  121. client = keycloak_admin.get_client(client_id="client_id")
  122. # Get all roles for the realm or client
  123. realm_roles = keycloak_admin.get_realm_roles()
  124. # Get all roles for the client
  125. client_roles = keycloak_admin.get_client_roles(client_id="client_id")
  126. # Get client role
  127. role = keycloak_admin.get_client_role(client_id="client_id", role_name="role_name")
  128. # Warning: Deprecated
  129. # Get client role id from name
  130. role_id = keycloak_admin.get_client_role_id(client_id="client_id", role_name="test")
  131. # Create client role
  132. keycloak_admin.create_client_role(client_id, "test")
  133. # Assign client role to user. Note that BOTH role_name and role_id appear to be required.
  134. keycloak_admin.assign_client_role(client_id="client_id", user_id="user_id", role_id="role_id", role_name="test")
  135. # Create new group
  136. group = keycloak_admin.create_group(name="Example Group")
  137. # Get all groups
  138. groups = keycloak_admin.get_groups()
  139. # Get group
  140. group = keycloak_admin.get_group(group_id='group_id')
  141. # Get group by name
  142. group = keycloak_admin.get_group_by_name(name_or_path='group_id', search_in_subgroups=True)
  143. ```