Merge pull request #121 from fschmtt/keycloak-26

fschmtt · web-flow · commit a840b4e42868 · 2024-10-09T14:36:47.000+02:00
feat: Keycloak 26 support
diff --git a/.github/workflows/php-integration.yml b/.github/workflows/php-integration.yml
@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        keycloak: [ 17.0.0, 18.0.0, 19.0.0, 20.0.0, 21.0.0, 22.0.0, 22.0.5, 23.0.0, 24.0.0, 25.0.0 ]
+        keycloak: [ 17.0.0, 18.0.0, 19.0.0, 20.0.0, 21.0.0, 22.0.0, 22.0.5, 23.0.0, 24.0.0, 25.0.0, 26.0.0 ]
         php: [ 8.1 ]
 
     env:
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 # Keycloak Admin REST API Client
 
-PHP client to interact with [Keycloak's Admin REST API](https://www.keycloak.org/docs-api/25.0.0/rest-api/index.html).
+PHP client to interact with [Keycloak's Admin REST API](https://www.keycloak.org/docs-api/26.0.0/rest-api/index.html).
 
 Inspired by [keycloak/keycloak-nodejs-admin-client](https://github.com/keycloak/keycloak-nodejs-admin-client).
 
@@ -49,7 +49,7 @@ echo sprintf(
 will print e.g.
 
 ```text
-Keycloak 25.0.0 is running on Linux/5.10.25-linuxkit (amd64) with OpenJDK 64-Bit Server VM/11.0.11 since 0 days, 2 hours, 37 minutes, 7 seconds and is currently using 139 MB of 512 MB (28 %) memory.
+Keycloak 26.0.0 is running on Linux/5.10.25-linuxkit (amd64) with OpenJDK 64-Bit Server VM/11.0.11 since 0 days, 2 hours, 37 minutes, 7 seconds and is currently using 139 MB of 512 MB (28 %) memory.
 ```
 
 More examples can be found in the [examples](examples) directory.
@@ -104,15 +104,15 @@ $myCustomRepresentation = $myCustomResource->myCustomEndpoint();
 
 ## Available Resources
 
-### [Attack Detection](https://www.keycloak.org/docs-api/25.0.0/rest-api/index.html#_attack_detection)
+### [Attack Detection](https://www.keycloak.org/docs-api/26.0.0/rest-api/index.html#_attack_detection)
 
 | Endpoint                                                                   | Response                | API                                                               |
 |----------------------------------------------------------------------------|-------------------------|-------------------------------------------------------------------|
 | `DELETE /admin/realms/{realm}/attack-detection/brute-force/users`          | `n/a`                   | [AttackDetection::clear()](src/Resource/AttackDetection.php)      |
 | `GET /admin/realms/{realm}/attack-detection/brute-force/users/{userId}`    | [Map](src/Type/Map.php) | [AttackDetection::userStatus()](src/Resource/AttackDetection.php) |
 | `DELETE /admin/realms/{realm}/attack-detection/brute-force/users/{userId}` | `n/a`                   | [AttackDetection::clearUser()](src/Resource/AttackDetection.php)  |
 
-### [Clients](https://www.keycloak.org/docs-api/25.0.0/rest-api/index.html#_clients)
+### [Clients](https://www.keycloak.org/docs-api/26.0.0/rest-api/index.html#_clients)
 
 | Endpoint                                                       | Response                                                | API                                                    |
 |----------------------------------------------------------------|---------------------------------------------------------|--------------------------------------------------------|
@@ -122,7 +122,7 @@ $myCustomRepresentation = $myCustomResource->myCustomEndpoint();
 | `POST /admin/realms/{realm}/clients`                           | [Client](src/Representation/Client.php)                 | [Clients::import()](src/Resource/Clients.php)          |
 | `GET /admin/realms/{realm}/clients/{clientUuid}/client-secret` | [Client](src/Representation/Client.php)                 | [Clients::getClientSecret()](src/Resource/Clients.php) |
 
-### [Groups](https://www.keycloak.org/docs-api/25.0.0/rest-api/index.html#_clients)
+### [Groups](https://www.keycloak.org/docs-api/26.0.0/rest-api/index.html#_clients)
 
 | Endpoint                                          | Response                                              | API                                           |
 |---------------------------------------------------|-------------------------------------------------------|-----------------------------------------------|
@@ -134,7 +134,7 @@ $myCustomRepresentation = $myCustomResource->myCustomEndpoint();
 | `POST /admin/realms/{realm}/groups/{id}/children` | `n/a`                                                 | [Groups::create()](src/Resource/Groups.php)   |
 | `DELETE /admin/realms/{realm}/groups`             | `n/a`                                                 | [Groups::delete()](src/Resource/Groups.php)   |
 
-### [Realms Admin](https://www.keycloak.org/docs-api/25.0.0/rest-api/index.html#_realms_admin)
+### [Realms Admin](https://www.keycloak.org/docs-api/26.0.0/rest-api/index.html#_realms_admin)
 
 | Endpoint                                       | Response                                              | API                                                    |
 |------------------------------------------------|-------------------------------------------------------|--------------------------------------------------------|
@@ -149,7 +149,7 @@ $myCustomRepresentation = $myCustomResource->myCustomEndpoint();
 | `POST /admin/realms/{realm}/clear-realm-cache` | `n/a`                                                 | [Realms::clearRealmCache()](src/Resource/Realms.php)   |
 | `POST /admin/realms/{realm}/clear-user-cache`  | `n/a`                                                 | [Realms::clearUserCache()](src/Resource/Realms.php)    |
 
-### [Users](https://www.keycloak.org/docs-api/25.0.0/rest-api/index.html#_users)
+### [Users](https://www.keycloak.org/docs-api/26.0.0/rest-api/index.html#_users)
 
 | Endpoint                                                | Response                                                        | API                                                            |
 |---------------------------------------------------------|-----------------------------------------------------------------|----------------------------------------------------------------|
@@ -169,7 +169,7 @@ $myCustomRepresentation = $myCustomResource->myCustomEndpoint();
 | `PUT /{realm}/users/{id}/execute-actions-email`         | `n/a`                                                           | [Users::executeActionsEmail()](src/Resource/Users.php)         |
 | `GET /admin/realms/{realm}/users/{userId}/credentials`  | [CredentialCollection](src/Collection/CredentialCollection.php) | [Users::credentials()](src/Resource/Users.php)                 |
 
-### [Roles](https://www.keycloak.org/docs-api/25.0.0/rest-api/index.html#_roles)
+### [Roles](https://www.keycloak.org/docs-api/26.0.0/rest-api/index.html#_roles)
 
 | Endpoint                                        | Response                                            | API                                       |
 |-------------------------------------------------|-----------------------------------------------------|-------------------------------------------|
@@ -178,7 +178,7 @@ $myCustomRepresentation = $myCustomResource->myCustomEndpoint();
 | `POST /admin/realms/{realm}/roles`              | `n/a`                                               | [Roles::create()](src/Resource/Roles.php) |
 | `DELETE /admin/realms/{realm}/roles/{roleName}` | `n/a`                                               | [Roles::delete()](src/Resource/Roles.php) |
 
-### [Root](https://www.keycloak.org/docs-api/25.0.0/rest-api/index.html#_root)
+### [Root](https://www.keycloak.org/docs-api/26.0.0/rest-api/index.html#_root)
 
 | Endpoint                | Response                                        | API                                              |
 |-------------------------|-------------------------------------------------|--------------------------------------------------|
diff --git a/compose.yaml b/compose.yaml
@@ -6,7 +6,7 @@ services:
     working_dir: /app
 
   keycloak:
-    image: quay.io/keycloak/keycloak:24.0.0
+    image: quay.io/keycloak/keycloak:25.0.0
     command: start-dev
     environment:
       KEYCLOAK_ADMIN: admin
diff --git a/tests/Unit/Http/PropertyFilterTest.php b/tests/Unit/Http/PropertyFilterTest.php
@@ -99,5 +99,6 @@ public static function supportedKeycloakVersions(): Generator
         yield ['23.0.0'];
         yield ['24.0.0'];
         yield ['25.0.0'];
+        yield ['26.0.0'];
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -99,5 +99,6 @@ public static function supportedKeycloakVersions(): Generator`
`99`	`99`	`yield ['23.0.0'];`
`100`	`100`	`yield ['24.0.0'];`
`101`	`101`	`yield ['25.0.0'];`
	`102`	`+ yield ['26.0.0'];`
`102`	`103`	`}`
`103`	`104`	`}`