Add Client::getClientSecret() endpoint

fschmtt · Aug 20, 2024 · e402e69 · e402e69
1 parent 7690e40
commit e402e69
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -114,12 +114,13 @@ $myCustomRepresentation = $myCustomResource->myCustomEndpoint();
 
 ### [Clients](https://www.keycloak.org/docs-api/25.0.0/rest-api/index.html#_clients)
 
-| Endpoint                                          | Response                                                | API                                           |
-|---------------------------------------------------|---------------------------------------------------------|-----------------------------------------------|
-| `GET /admin/realms/{realm}/clients`               | [ClientCollection](src/Collection/ClientCollection.php) | [Clients::all()](src/Resource/Clients.php)    |
-| `GET /admin/realms/{realm}/clients/{client-uuid}` | [Client](src/Representation/Client.php)                 | [Clients::get()](src/Resource/Clients.php)    |
-| `PUT /admin/realms/{realm}/clients/{client-uuid}` | [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) |
+| Endpoint                                                       | Response                                                | API                                                    |
+|----------------------------------------------------------------|---------------------------------------------------------|--------------------------------------------------------|
+| `GET /admin/realms/{realm}/clients`                            | [ClientCollection](src/Collection/ClientCollection.php) | [Clients::all()](src/Resource/Clients.php)             |
+| `GET /admin/realms/{realm}/clients/{client-uuid}`              | [Client](src/Representation/Client.php)                 | [Clients::get()](src/Resource/Clients.php)             |
+| `PUT /admin/realms/{realm}/clients/{client-uuid}`              | [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)          |
+| `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)
 

diff --git a/examples/users-all.php b/examples/users-all.php
@@ -19,4 +19,10 @@
 
 foreach ($users as $user) {
     echo sprintf('-> User "%s"%s', $user->getUsername(), PHP_EOL);
+
+    echo sprintf('--> Required actions:%s', PHP_EOL);
+
+    foreach ($user->getRequiredActions() ?? [] as $requiredAction) {
+        echo sprintf('---> %s%s', $requiredAction, PHP_EOL);
+    }
 }
diff --git a/src/Resource/Clients.php b/src/Resource/Clients.php
@@ -10,6 +10,7 @@
 use Fschmtt\Keycloak\Http\Method;
 use Fschmtt\Keycloak\Http\Query;
 use Fschmtt\Keycloak\Representation\Client as ClientRepresentation;
+use Fschmtt\Keycloak\Representation\Credential;
 
 /**
  * @phpstan-type UserSession array<mixed>
@@ -108,4 +109,18 @@ public function getUserSessions(string $realm, string $clientUuid, ?Criteria $cr
             )
         );
     }
+
+    public function getClientSecret(string $realm, string $clientUuid): Credential
+    {
+        return $this->queryExecutor->executeQuery(
+            new Query(
+                '/admin/realms/{realm}/clients/{clientUuid}/client-secret',
+                Credential::class,
+                [
+                    'realm' => $realm,
+                    'clientUuid' => $clientUuid,
+                ]
+            )
+        );
+    }
 }
diff --git a/tests/Integration/Resource/ClientsTest.php b/tests/Integration/Resource/ClientsTest.php
@@ -60,4 +60,17 @@ public function testGetUserSessions(): void
 
         $resource->getUserSessions('master', $client->getId());
     }
+
+    public function testGetClientSecret(): void
+    {
+        $resource = $this->getKeycloak()->clients();
+
+        $client = $resource->all('master')->first();
+        static::assertInstanceOf(Client::class, $client);
+
+        $clientUuid = $client->getId();
+        static::assertIsString($clientUuid);
+
+        $credential = $resource->getClientSecret('master', $clientUuid);
+    }
 }
diff --git a/tests/Unit/Resource/ClientsTest.php b/tests/Unit/Resource/ClientsTest.php
@@ -11,6 +11,7 @@
 use Fschmtt\Keycloak\Http\Query;
 use Fschmtt\Keycloak\Http\QueryExecutor;
 use Fschmtt\Keycloak\Representation\Client as ClientRepresentation;
+use Fschmtt\Keycloak\Representation\Credential;
 use Fschmtt\Keycloak\Resource\Clients;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
@@ -242,4 +243,39 @@ public function testGetUserSessions(): void
             $clients->getUserSessions('test-realm', $clientId)
         );
     }
+
+    public function testGetClientSecret(): void
+    {
+        $client = new ClientRepresentation(id: 'test-client');
+        $clientUuid = $client->getId();
+
+        static::assertIsString($clientUuid);
+
+        $credential = new Credential();
+
+        $query = new Query(
+            '/admin/realms/{realm}/clients/{clientUuid}/client-secret',
+            Credential::class,
+            [
+                'realm' => 'test-realm',
+                'clientUuid' => $clientUuid,
+            ],
+        );
+
+        $queryExecutor = $this->createMock(QueryExecutor::class);
+        $queryExecutor->expects(static::once())
+            ->method('executeQuery')
+            ->with($query)
+            ->willReturn($credential);
+
+        $clients = new Clients(
+            $this->createMock(CommandExecutor::class),
+            $queryExecutor,
+        );
+
+        static::assertSame(
+            $credential,
+            $clients->getClientSecret('test-realm', $clientUuid)
+        );
+    }
 }