Merge pull request #69 from fschmtt/keycloak-22

Add compatibility for Keycloak 22

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]
+        keycloak: [17.0.0, 18.0.0, 19.0.0, 20.0.0, 21.0.0, 22.0.0]
 
     env:
       KEYCLOAK_VERSION: ${{ matrix.keycloak }}

README.md

@@ -4,7 +4,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/21.0.0/rest-api/index.html).
+PHP client to interact with [Keycloak's Admin REST API](https://www.keycloak.org/docs-api/22.0.0/rest-api/index.html).
 
 Inspired by [keycloak/keycloak-nodejs-admin-client](https://github.com/keycloak/keycloak-nodejs-admin-client).
 
@@ -42,28 +42,28 @@ echo sprintf(
 ```
 will print e.g.
 ```text
-Keycloak 21.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 22.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.
 
 ## Available Resources
-### [Attack Detection](https://www.keycloak.org/docs-api/21.0.0/rest-api/index.html#_attack_detection_resource)
+### [Attack Detection](https://www.keycloak.org/docs-api/22.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/21.0.0/rest-api/index.html#_clients_resource)
+### [Clients](https://www.keycloak.org/docs-api/22.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/21.0.0/rest-api/index.html#_clients_resource)
+### [Groups](https://www.keycloak.org/docs-api/22.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) |
@@ -72,7 +72,7 @@ More examples can be found in the [examples](examples) directory.
 | `POST /admin/realms/{realm}/groups` | `n/a` | [Groups::import()](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/21.0.0/rest-api/index.html#_realms_admin_resource)
+### [Realms Admin](https://www.keycloak.org/docs-api/22.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) |
@@ -85,7 +85,7 @@ More examples can be found in the [examples](examples) directory.
 | `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/21.0.0/rest-api/index.html#_users_resource)
+### [Users](https://www.keycloak.org/docs-api/22.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) |
@@ -102,15 +102,15 @@ More examples can be found in the [examples](examples) directory.
 | `POST /{realm}/users/{id}/role-mappings/realm` | `n/a` | [Users::addRealmRoles()](src/Resource/Users.php) |
 | `DELETE /{realm}/users/{id}/role-mappings/realm` | `n/a` | [Users::removeRealmRoles()](src/Resource/Users.php) |
 
-### [Roles](https://www.keycloak.org/docs-api/21.0.0/rest-api/index.html#_roles_resource)
+### [Roles](https://www.keycloak.org/docs-api/22.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/21.0.0/rest-api/index.html#_root_resource)
+### [Root](https://www.keycloak.org/docs-api/22.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:21.0.0
+    image: quay.io/keycloak/keycloak:22.0.0
     command: start-dev
     environment:
       KEYCLOAK_ADMIN: admin

docker/keycloak/Dockerfile

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

src/Collection/AuthenticationExecutionExportCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\AuthenticationExecutionExport;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<AuthenticationExecutionExport>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class AuthenticationExecutionExportCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/AuthenticationFlowCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\AuthenticationFlow;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<AuthenticationFlow>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class AuthenticationFlowCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/AuthenticatorConfigCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\AuthenticatorConfig;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<AuthenticatorConfig>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class AuthenticatorConfigCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/ClientCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\Client;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<Client>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class ClientCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/ClientPolicyCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\ClientPolicy;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<ClientPolicy>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class ClientPolicyCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/ClientPolicyExecutorCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\ClientPolicyExecutor;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<ClientPolicyExecutor>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class ClientPolicyExecutorCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/ClientProfileCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\ClientProfile;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<ClientProfile>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class ClientProfileCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/ClientScopeCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\ClientScope;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<ClientScope>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class ClientScopeCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/CredentialCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\Credential;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<Credential>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class CredentialCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/FederatedIdentityCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\FederatedIdentity;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<FederatedIdentity>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class FederatedIdentityCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/GroupCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\Group;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<Group>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class GroupCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/IdentityProviderCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\IdentityProvider;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<IdentityProvider>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class IdentityProviderCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/IdentityProviderMapperCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\IdentityProviderMapper;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<IdentityProviderMapper>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class IdentityProviderMapperCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/PasswordPolicyTypeCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\PasswordPolicyType;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<PasswordPolicyType>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class PasswordPolicyTypeCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/PolicyCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\Policy;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<Policy>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class PolicyCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/ProtocolMapperCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\ProtocolMapper;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<ProtocolMapper>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class ProtocolMapperCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/RealmCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\Realm;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<Realm>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class RealmCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/RequiredActionProviderCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\RequiredActionProvider;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<RequiredActionProvider>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class RequiredActionProviderCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/ResourceCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\Resource;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<Resource>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class ResourceCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/RoleCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\Role;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<Role>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class RoleCollection extends Collection
 {
     public static function getRepresentationClass(): string

src/Collection/ScopeCollection.php

@@ -5,11 +5,12 @@
 namespace Fschmtt\Keycloak\Collection;
 
 use Fschmtt\Keycloak\Representation\Scope;
+use PHPUnit\Framework\Attributes\IgnoreClassForCodeCoverage;
 
 /**
- * @codeCoverageIgnore
  * @extends Collection<Scope>
  */
+#[IgnoreClassForCodeCoverage(self::class)]
 class ScopeCollection extends Collection
 {
     public static function getRepresentationClass(): string