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.

731 lines
11 KiB

  1. ## v4.7.1 (2024-11-13)
  2. ### Fix
  3. - make sure to not call sync IO functions inside async functions (#615)
  4. ## v4.7.0 (2024-11-03)
  5. ### Feat
  6. - add client scope client-specific role mappings (#605)
  7. ## v4.6.3 (2024-10-26)
  8. ### Fix
  9. - Add optional Nonce parameter to the authorization URL requests (#606)
  10. ## v4.6.2 (2024-10-05)
  11. ### Fix
  12. - add scopes to device auth (#599)
  13. ## v4.6.1 (2024-10-05)
  14. ### Fix
  15. - changed sync get user id to async get user in create user async function (#600)
  16. ## v4.6.0 (2024-10-04)
  17. ### Feat
  18. - Add the max_retries parameter (#598)
  19. ## v4.5.1 (2024-10-02)
  20. ### Fix
  21. - Set client_credentials as grant_type also when x509 certificate is given (#597)
  22. ## v4.5.0 (2024-09-28)
  23. ### Feat
  24. - add ability to remove composite client roles (#596)
  25. ## v4.4.0 (2024-09-14)
  26. ### Feat
  27. - add matchingUri support for listing resources with wildcards (#592)
  28. ## v4.3.0 (2024-08-01)
  29. ### Feat
  30. - allow the use of client certificates in all requests (#584)
  31. ## v4.2.3 (2024-07-24)
  32. ### Fix
  33. - use a_public_key() in a_decode_token() instead of public_key() (#582)
  34. ## v4.2.2 (2024-07-16)
  35. ### Fix
  36. - correctly pass query params in a_send_update_account and a_send_verify_email (#581)
  37. ## v4.2.1 (2024-07-11)
  38. ### Fix
  39. - passing timeout values to ConnectionManager (#578)
  40. ## v4.2.0 (2024-06-22)
  41. ### Feat
  42. - functions for updating resource permissions and getting associated policies for a permission (#574)
  43. ## v4.1.0 (2024-06-06)
  44. ### Feat
  45. - Async feature (#566)
  46. ## v4.0.1 (2024-06-04)
  47. ### Fix
  48. - Leeway config (#568)
  49. ## v4.0.0 (2024-04-27)
  50. ### BREAKING CHANGE
  51. - changes signatures significantly
  52. - Many attributes removed from the admin class
  53. ### Feat
  54. - Merge pull request #556 from marcospereirampj/release/4.0.0
  55. - re-enable full group hierarchy fetching
  56. ### Fix
  57. - removed dead code, stabilized tests
  58. - removed deprecated functionality
  59. ### Refactor
  60. - refactored decode_token
  61. ## v3.12.0 (2024-04-10)
  62. ### Feat
  63. - allows retrieval of realm and client level roles for a user (#512)
  64. ## v3.11.1 (2024-04-08)
  65. ### Fix
  66. - lowercase default role name (#547)
  67. ## v3.11.0 (2024-04-08)
  68. ### Feat
  69. - add admin group count (#540)
  70. ## v3.10.2 (2024-04-08)
  71. ### Fix
  72. - fix keycloak_admin.create_user documentation/ typehint (#545)
  73. ## v3.10.1 (2024-04-07)
  74. ### Fix
  75. - improve KeycloakAdmin.get_client_id() performances (#511)
  76. ## v3.10.0 (2024-04-07)
  77. ### Feat
  78. - Allow query parameters for group children (#534)
  79. ## v3.9.3 (2024-04-07)
  80. ### Fix
  81. - incorporate custom headers into default header setup (#533)
  82. ## v3.9.2 (2024-04-07)
  83. ### Fix
  84. - get_groups pagination call was not used #537 (#541)
  85. ## v3.9.1 (2024-02-26)
  86. ### Fix
  87. - use jwcrypto and remove python-jose
  88. - replace python-jose with jwcrypto
  89. ## v3.9.0 (2024-02-16)
  90. ### Feat
  91. - new docs.
  92. - new docs.
  93. - new docs.
  94. - new docs.
  95. - new docs.
  96. - new docs.
  97. - new docs.
  98. ### Fix
  99. - updated readme.
  100. ## v3.8.4 (2024-02-15)
  101. ### Fix
  102. - use grant type password with client secret
  103. ## v3.8.3 (2024-02-14)
  104. ### Fix
  105. - name of client_id parameter
  106. ## v3.8.2 (2024-02-14)
  107. ### Fix
  108. - update readme.
  109. ## v3.8.1 (2024-02-13)
  110. ### Fix
  111. - linter check
  112. - updated dependencies
  113. ## v3.8.0 (2024-02-13)
  114. ### Feat
  115. - Adding additional methods to support roles-by-id api calls Most of the methods rely on the role name within python keycloak, which for the vast majority is fine, however there are some role names which cannot be used by the API endpoint as they contain characters that cannot be encoded properly. Therefore this change is to allow the use of the role's id to get, update and delete roles by their id instead.'
  116. ### Fix
  117. - Removing the admin realm variable which I created and is no longer needed
  118. ## v3.7.1 (2024-02-13)
  119. ### Fix
  120. - action bump
  121. - linter check.
  122. - depracated endpoint and fix groups services.
  123. - deprecate entitlement
  124. ## v3.7.0 (2023-11-13)
  125. ### Feat
  126. - realm changing helpers
  127. ### Fix
  128. - no prints
  129. ## v3.6.1 (2023-11-13)
  130. ### Fix
  131. - Ci/fix tests (#506)
  132. ## v3.6.0 (2023-11-13)
  133. ### Feat
  134. - add KeycloakAdmin.get_idp() (#478)
  135. ## v3.5.0 (2023-11-13)
  136. ### Feat
  137. - Update dynamic client using registration access token (#491)
  138. ## v3.4.0 (2023-11-13)
  139. ### Feat
  140. - add an optional search criteria to the get_realm_roles function (#504)
  141. ## v3.3.0 (2023-06-27)
  142. ### Feat
  143. - added KeycloakAdmin.update_client_authz_resource() (#462)
  144. ## v3.2.0 (2023-06-23)
  145. ### Feat
  146. - Implement missing admin method create_client_authz_scope_based_permission() and create_client_authz_policy() (#460)
  147. ## v3.1.1 (2023-06-23)
  148. ### Fix
  149. - remove duplicate slash in URL_ADMIN_IDP (#459)
  150. ## v3.1.0 (2023-06-23)
  151. ### Feat
  152. - Add query to get users group method and permit pagination (#444)
  153. ## v3.0.0 (2023-05-28)
  154. ### BREAKING CHANGE
  155. - Changes the exchange token API
  156. ### Refactor
  157. - Exchange token method
  158. ## v2.16.6 (2023-05-28)
  159. ### Fix
  160. - relax the version constraints
  161. ## v2.16.5 (2023-05-28)
  162. ### Fix
  163. - do not swap realm for user_realm when logging in with a client service account (#447)
  164. ## v2.16.4 (2023-05-28)
  165. ### Perf
  166. - improve performance of get_user_id (#449)
  167. ## v2.16.3 (2023-05-15)
  168. ### Fix
  169. - Fixes `Authorization.load_config` breaking if a scope based permission is linked with anything other than a role based policy. Fixes #445 (#446)
  170. ## v2.16.2 (2023-05-09)
  171. ### Fix
  172. - issue with app engine reported in #440 (#442)
  173. ## v2.16.1 (2023-05-01)
  174. ### Fix
  175. - Initializing KeycloakAdmin without server_url (#439)
  176. ## v2.16.0 (2023-04-28)
  177. ### Feat
  178. - Add get and delete methods for client authz resources (#435)
  179. ## v2.15.4 (2023-04-28)
  180. ### Fix
  181. - **pyproject.toml**: loose requests pgk and remove urllib3 as dependency (#434)
  182. ## v2.15.3 (2023-04-06)
  183. ### Fix
  184. - Check if _s exists in ConnectionManager before deleting it (#429)
  185. ## v2.15.2 (2023-04-05)
  186. ### Fix
  187. - deprecation warnings in keycloak_admin.py (#425)
  188. ## v2.15.1 (2023-04-05)
  189. ### Fix
  190. - improved type-hints (#427)
  191. ## v2.15.0 (2023-04-05)
  192. ### Feat
  193. - Add UMA policy management and permission tickets (#426)
  194. ## v2.14.0 (2023-03-17)
  195. ### Feat
  196. - add initial access token support and policy delete method
  197. ## v2.13.2 (2023-03-06)
  198. ### Fix
  199. - Refactor auto refresh (#415)
  200. ## v2.13.1 (2023-03-05)
  201. ### Fix
  202. - Check if applyPolicies exists in the config (#367)
  203. ## v2.13.0 (2023-03-05)
  204. ### Feat
  205. - implement cache clearing API (#414)
  206. ## v2.12.2 (2023-03-05)
  207. ### Fix
  208. - get_group_by_path uses Keycloak API to load (#417)
  209. ## v2.12.1 (2023-03-05)
  210. ### Fix
  211. - tests and upgraded deps (#419)
  212. ## v2.12.0 (2023-02-10)
  213. ### Feat
  214. - add Keycloak UMA client (#403)
  215. ## v2.11.1 (2023-02-08)
  216. ### Fix
  217. - do not include CODEOWNERS (#407)
  218. ## v2.11.0 (2023-02-08)
  219. ### Feat
  220. - Add Client Scopes of Client
  221. ## v2.10.0 (2023-02-08)
  222. ### Feat
  223. - update header if token is given
  224. - init KeycloakAdmin with token
  225. ## v2.9.0 (2023-01-11)
  226. ### Feat
  227. - added default realm roles handlers
  228. ## v2.8.0 (2022-12-29)
  229. ### Feat
  230. - **api**: add tests for create_authz_scopes
  231. ### Fix
  232. - fix testing create_client_authz_scopes parameters
  233. - fix linting
  234. - add testcase for invalid client id
  235. - create authz clients test case
  236. - create authz clients test case
  237. ## v2.7.0 (2022-12-24)
  238. ### Refactor
  239. - code formatting after tox checks
  240. - remove print statements
  241. ## v2.6.1 (2022-12-13)
  242. ### Feat
  243. - option for enabling users
  244. - helping functions for disabling users
  245. ### Fix
  246. - use version from the package
  247. - default scope to openid
  248. ## v2.6.0 (2022-10-03)
  249. ### Feat
  250. - attack detection API implementation
  251. ## v2.5.0 (2022-08-19)
  252. ### Feat
  253. - added missing functionality to include attributes when returning realm roles according to specifications
  254. ## v2.4.0 (2022-08-19)
  255. ### Feat
  256. - add client scope-mappings client roles operations
  257. ## v2.3.0 (2022-08-13)
  258. ### Feat
  259. - Add token_type/scope to token exchange api
  260. ## v2.2.0 (2022-08-12)
  261. ### Feat
  262. - add client scope-mappings realm roles operations
  263. ## v2.1.1 (2022-07-19)
  264. ### Fix
  265. - removed whitespace from urls
  266. ### Refactor
  267. - applied linting
  268. ## v2.1.0 (2022-07-18)
  269. ### Feat
  270. - add unit tests
  271. - add docstrings
  272. - add functions covering some missing REST API calls
  273. ### Fix
  274. - linting
  275. - now get_required_action_by_alias now returns None if action does not exist
  276. - moved imports at the top of the file
  277. - remove duplicate function
  278. - applied tox -e docs
  279. - applied flake linting checks
  280. - applied tox linting check
  281. ## v2.0.0 (2022-07-17)
  282. ### BREAKING CHANGE
  283. - Renamed parameter client_name to client_id in get_client_id method
  284. ### Fix
  285. - check client existence based on clientId
  286. ## v1.9.1 (2022-07-13)
  287. ### Fix
  288. - turn get_name into a method, use setters in connection manager
  289. ### Refactor
  290. - no need to try if the type check is performed
  291. ## v1.9.0 (2022-07-13)
  292. ### Refactor
  293. - merge master branch into local
  294. ## v1.8.1 (2022-07-13)
  295. ### Feat
  296. - added flake8-docstrings and upgraded dependencies
  297. ### Fix
  298. - Support the auth_url method called with scope & state params now
  299. - raise correct exceptions
  300. ### Refactor
  301. - slight restructure of the base fixtures
  302. ## v1.8.0 (2022-06-22)
  303. ### Feat
  304. - Ability to set custom timeout for KCOpenId and KCAdmin
  305. ## v1.7.0 (2022-06-16)
  306. ### Feat
  307. - Allow fetching existing policies before calling create_client_authz_client_policy()
  308. ## v1.6.0 (2022-06-13)
  309. ### Feat
  310. - support token exchange config via admin API
  311. ## v1.5.0 (2022-06-03)
  312. ### Feat
  313. - Add update_idp
  314. ## v1.4.0 (2022-06-02)
  315. ### Feat
  316. - Add update_mapper_in_idp
  317. ## v1.3.0 (2022-05-31)
  318. ## v1.2.0 (2022-05-31)
  319. ### Feat
  320. - Support Token Exchange. Fixes #305
  321. - Add get_idp_mappers, fix #329
  322. ## v1.1.1 (2022-05-27)
  323. ### Fix
  324. - fixed bugs in events methods
  325. - fixed components bugs
  326. - use param for update client mapper
  327. ## v1.1.0 (2022-05-26)
  328. ### Feat
  329. - added new methods for client scopes
  330. ## v1.0.1 (2022-05-25)
  331. ### Fix
  332. - allow query parameters for users count
  333. ## v1.0.0 (2022-05-25)
  334. ### BREAKING CHANGE
  335. - Renames `KeycloakOpenID.well_know` to `KeycloakOpenID.well_known`
  336. ### Fix
  337. - correct spelling of public API method
  338. ## v0.29.1 (2022-05-24)
  339. ### Fix
  340. - allow client_credentials token if username and password not specified
  341. ## v0.29.0 (2022-05-23)
  342. ### Feat
  343. - added UMA-permission request functionality
  344. ### Fix
  345. - added fixes based on feedback
  346. ## v0.28.3 (2022-05-23)
  347. ### Fix
  348. - import classes in the base module
  349. ## v0.28.2 (2022-05-19)
  350. ### Fix
  351. - escape when get role fails
  352. ## v0.28.1 (2022-05-19)
  353. ### Fix
  354. - Add missing keycloak.authorization package
  355. ## v0.28.0 (2022-05-19)
  356. ### Feat
  357. - added authenticator providers getters
  358. - fixed admin client to pass the tests
  359. - initial setup of CICD and linting
  360. ### Fix
  361. - full tox fix ready
  362. - raise correct errors
  363. ### Refactor
  364. - isort conf.py
  365. - Merge branch 'master' into feature/cicd
  366. ## v0.27.1 (2022-05-18)
  367. ### Fix
  368. - **release**: version bumps for hotfix release
  369. ## v0.27.0 (2022-02-16)
  370. ### Fix
  371. - handle refresh_token error "Session not active"
  372. ## v0.26.1 (2021-08-30)
  373. ### Feat
  374. - add KeycloakAdmin.set_events
  375. ## v0.25.0 (2021-05-05)
  376. ## v0.24.0 (2020-12-18)
  377. ## 0.23.0 (2020-11-19)
  378. ## v0.22.0 (2020-08-16)
  379. ## v0.21.0 (2020-06-30)
  380. ### Feat
  381. - add components
  382. ## v0.20.0 (2020-04-11)
  383. ## v0.19.0 (2020-02-18)
  384. ## v0.18.0 (2019-12-10)
  385. ## v0.17.6 (2019-10-10)