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.

725 lines
11 KiB

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