Merge pull request #91 from fschmtt/keycloak-24

Add support for Keycloak 24

Author: fschmtt

.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]
+        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]
 
     env:
       KEYCLOAK_VERSION: ${{ matrix.keycloak }}

README.md

@@ -5,7 +5,7 @@
 ![PHP Legacy (Keycloak compatibility)](https://github.com/fschmtt/keycloak-rest-api-client-php/actions/workflows/php-integration-legacy.yml/badge.svg?branch=main)
 
 # Keycloak Admin REST API Client
-PHP client to interact with [Keycloak's Admin REST API](https://www.keycloak.org/docs-api/23.0.0/rest-api/index.html).
+PHP client to interact with [Keycloak's Admin REST API](https://www.keycloak.org/docs-api/24.0.0/rest-api/index.html).
 
 Inspired by [keycloak/keycloak-nodejs-admin-client](https://github.com/keycloak/keycloak-nodejs-admin-client).
 
@@ -43,7 +43,7 @@ echo sprintf(
 ```
 will print e.g.
 ```text
-Keycloak 23.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 24.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.
@@ -94,22 +94,22 @@ $myCustomRepresentation = $myCustomResource->myCustomEndpoint();
 ```
 
 ## Available Resources
-### [Attack Detection](https://www.keycloak.org/docs-api/23.0.0/rest-api/index.html#_attack_detection_resource)
+### [Attack Detection](https://www.keycloak.org/docs-api/24.0.0/rest-api/index.html#_attack_detection_resource)
 | 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/23.0.0/rest-api/index.html#_clients_resource)
+### [Clients](https://www.keycloak.org/docs-api/24.0.0/rest-api/index.html#_clients_resource)
 | Endpoint | Response | API |
 |----------|----------|-----|
 | `GET /admin/realms/{realm}/clients` | [ClientCollection](src/Collection/ClientCollection.php) | [Clients::all()](src/Resource/Clients.php) |
 | `GET /admin/realms/{realm}/clients/{id}` | [Client](src/Representation/Client.php) | [Clients::get()](src/Resource/Clients.php) |
 | `PUT /admin/realms/{realm}/clients/{id}` | [Client](src/Representation/Client.php) | [Clients::update()](src/Resource/Clients.php) |
 | `POST /admin/realms/{realm}/clients` | [Client](src/Representation/Client.php) | [Clients::import()](src/Resource/Clients.php) |
 
-### [Groups](https://www.keycloak.org/docs-api/23.0.0/rest-api/index.html#_clients_resource)
+### [Groups](https://www.keycloak.org/docs-api/24.0.0/rest-api/index.html#_clients_resource)
 | Endpoint                                          | Response | API                                           |
 |---------------------------------------------------|----------|-----------------------------------------------|
 | `GET /admin/realms/{realm}/groups`                | [GroupCollection](src/Collection/GroupCollection.php) | [Groups::all()](src/Resource/Groups.php)      |
@@ -120,7 +120,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/23.0.0/rest-api/index.html#_realms_admin_resource)
+### [Realms Admin](https://www.keycloak.org/docs-api/24.0.0/rest-api/index.html#_realms_admin_resource)
 | Endpoint | Response | API |
 |----------|----------|-----|
 | `POST /admin/realms` | [Realm](src/Representation/Realm.php) | [Realms::import()](src/Resource/Realms.php) |
@@ -134,7 +134,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/23.0.0/rest-api/index.html#_users_resource)
+### [Users](https://www.keycloak.org/docs-api/24.0.0/rest-api/index.html#_users_resource)
 | Endpoint | Response | API |
 |----------|----------|-----|
 | `GET /admin/realms/{realm}/users` | [UserCollection](src/Collection/UserCollection.php) | [Users::all()](src/Resource/Users.php) |
@@ -152,15 +152,15 @@ $myCustomRepresentation = $myCustomResource->myCustomEndpoint();
 | `DELETE /{realm}/users/{id}/role-mappings/realm` | `n/a` | [Users::removeRealmRoles()](src/Resource/Users.php) |
 | `PUT /{realm}/users/{id}/execute-actions-email` | `n/a` | [Users::executeActionsEmail()](src/Resource/Users.php) |
 
-### [Roles](https://www.keycloak.org/docs-api/23.0.0/rest-api/index.html#_roles_resource)
+### [Roles](https://www.keycloak.org/docs-api/24.0.0/rest-api/index.html#_roles_resource)
 | Endpoint | Response | API |
 |----------|----------|-----|
 | `GET /admin/realms/{realm}/roles` | [RoleCollection](src/Collection/RoleCollection.php) | [Roles::all()](src/Resource/Roles.php) |
 | `GET /admin/realms/{realm}/roles/{roleName}` | [Role](src/Representation/Role.php) | [Roles::get()](src/Resource/Roles.php) |
 | `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/23.0.0/rest-api/index.html#_root_resource)
+### [Root](https://www.keycloak.org/docs-api/24.0.0/rest-api/index.html#_root_resource)
 | Endpoint | Response | API |
 |----------|----------|-----|
 | `GET /admin/serverinfo` | [ServerInfo](src/Representation/ServerInfo.php) | [ServerInfo::get()](src/Resource/ServerInfo.php) |

docker-compose.yml

@@ -10,7 +10,7 @@ services:
     working_dir: /app
 
   keycloak:
-    image: quay.io/keycloak/keycloak:23.0.0
+    image: quay.io/keycloak/keycloak:24.0.0
     command: start-dev
     environment:
       KEYCLOAK_ADMIN: admin

docker/keycloak/Dockerfile

@@ -1,4 +1,4 @@
-ARG KEYCLOAK_VERSION=23.0.0
+ARG KEYCLOAK_VERSION=24.0.0
 FROM quay.io/keycloak/keycloak:${KEYCLOAK_VERSION}
 
 ENTRYPOINT [ "/opt/keycloak/bin/kc.sh", "start-dev" ]

src/Representation/Realm.php

@@ -68,7 +68,8 @@
  * @method int|null getEventsExpiration()
  * @method array|null getEventsListeners()
  * @method int|null getFailureFactor()
- * @method array|null getFederatedUsers()
+ * @method UserCollection|null getFederatedUsers()
+ * @method string|null getFirstBrokerLoginFlow()
  * @method GroupCollection|null getGroups()
  * @method string|null getId()
  * @method array|null getIdentityProviderMappers()
@@ -79,6 +80,7 @@
  * @method bool|null getLoginWithEmailAllowed()
  * @method int|null getMaxDeltaTimeSeconds()
  * @method int|null getMaxFailureWaitSeconds()
+ * @method int|null getMaxTemporaryLockouts()
  * @method int|null getMinimumQuickLoginWaitSeconds()
  * @method int|null getNotBefore()
  * @method int|null getOauth2DeviceCodeLifespan()
@@ -193,7 +195,8 @@
  * @method self withEventsExpiration(?int $value)
  * @method self withEventsListeners(?array $value)
  * @method self withFailureFactor(?int $value)
- * @method self withFederatedUsers(?array $value)
+ * @method self withFederatedUsers(?UserCollection $value)
+ * @method self withFirstBrokerLoginFlow(?string $value)
  * @method self withGroups(?GroupCollection $value)
  * @method self withId(?string $value)
  * @method self withIdentityProviderMappers(?array $value)
@@ -204,6 +207,7 @@
  * @method self withLoginWithEmailAllowed(?bool $value)
  * @method self withMaxDeltaTimeSeconds(?int $value)
  * @method self withMaxFailureWaitSeconds(?int $value)
+ * @method self withMaxTemporaryLockouts(?int $value)
  * @method self withMinimumQuickLoginWaitSeconds(?int $value)
  * @method self withNotBefore(?int $value)
  * @method self withOauth2DeviceCodeLifespan(?int $value)
@@ -330,6 +334,8 @@ public function __construct(
         protected ?array $eventsListeners = null,
         protected ?int $failureFactor = null,
         protected ?UserCollection $federatedUsers = null,
+        #[Since('24.0.0')]
+        protected ?string $firstBrokerLoginFlow = null,
         protected ?GroupCollection $groups = null,
         protected ?string $id = null,
         protected ?IdentityProviderMapperCollection $identityProviderMappers = null,
@@ -340,6 +346,8 @@ public function __construct(
         protected ?bool $loginWithEmailAllowed = null,
         protected ?int $maxDeltaTimeSeconds = null,
         protected ?int $maxFailureWaitSeconds = null,
+        #[Since('24.0.0')]
+        protected ?int $maxTemporaryLockouts = null,
         protected ?int $minimumQuickLoginWaitSeconds = null,
         protected ?int $notBefore = null,
         protected ?int $oauth2DeviceCodeLifespan = null,

tests/Unit/Http/PropertyFilterTest.php

@@ -102,5 +102,6 @@ public static function supportedKeycloakVersions(): Generator
         yield ['21.0.0'];
         yield ['22.0.0'];
         yield ['23.0.0'];
+        yield ['24.0.0'];
     }
 }