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.

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