AdminGetUser API

Author: ucan-lab

src/app/Aws/CognitoIdentityProvider/AdminGetUser/AdminGetUser.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Aws\CognitoIdentityProvider\AdminGetUser;
+
+/**
+ * ユーザープール内のユーザー名で指定されたユーザーを管理者として取得します。
+ *
+ * @link https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html#admingetuser
+ */
+interface AdminGetUser
+{
+    public function execute(AdminGetUserPayload $payload): AdminGetUserResult;
+}

src/app/Aws/CognitoIdentityProvider/AdminGetUser/AdminGetUserPayload.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Aws\CognitoIdentityProvider\AdminGetUser;
+
+final readonly class AdminGetUserPayload
+{
+    /**
+     * @param string $userPoolId
+     * @param string $username
+     */
+    private function __construct(
+        public string $userPoolId,
+        public string $username,
+    ) {
+    }
+
+    /**
+     * @param string $username
+     * @return $this
+     */
+    public static function create(string $username): self
+    {
+        return new self(
+            config('services.cognito.user_pool_id'),
+            $username,
+        );
+    }
+}

src/app/Aws/CognitoIdentityProvider/AdminGetUser/AdminGetUserResult.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Aws\CognitoIdentityProvider\AdminGetUser;
+
+use App\Aws\CognitoType\AttributeType;
+use App\Aws\CognitoType\UserMFASetting;
+use App\Aws\CognitoType\UserMFASettingList;
+use App\Aws\CognitoType\UserStatus;
+use Aws\Result;
+use Carbon\Carbon;
+
+final readonly class AdminGetUserResult
+{
+    /**
+     * @param bool $enabled
+     * @param array $mFAOptions 非推奨オプション。userMFASettingListの方を参照する
+     * @param UserMFASetting|null $preferredMfaSetting ユーザーの好みの優先MFA設定
+     * @param AttributeType $userAttributes ユーザー属性
+     * @param Carbon $userCreateDate ユーザー作成日
+     * @param Carbon $userLastModifiedDate ユーザー最終更新日
+     * @param UserMFASettingList $userMFASettingList ユーザーMFA設定リスト
+     * @param UserStatus $userStatus ユーザーステータス
+     * @param string $username
+     */
+    private function __construct(
+        public bool $enabled,
+        public array $mFAOptions,
+        public ?UserMFASetting $preferredMfaSetting,
+        public AttributeType $userAttributes,
+        public Carbon $userCreateDate,
+        public Carbon $userLastModifiedDate,
+        public UserMFASettingList $userMFASettingList,
+        public UserStatus $userStatus,
+        public string $username,
+    ) {
+    }
+
+    /**
+     * @param Result $result
+     * @return static
+     */
+    public static function createForAws(Result $result): self
+    {
+        return new self(
+            $result->get('Enabled'),
+            $result->get('MFAOptions') ?? [],
+            $result->get('PreferredMfaSetting') ? UserMFASetting::from($result->get('PreferredMfaSetting')) : null,
+            AttributeType::create($result->get('UserAttributes')),
+            Carbon::instance($result->get('UserCreateDate')),
+            Carbon::instance($result->get('UserLastModifiedDate')),
+            UserMFASettingList::create($result->get('UserMFASettingList') ?? []),
+            UserStatus::from($result->get('UserStatus')),
+            $result->get('Username'),
+        );
+    }
+
+    /**
+     * @param array $result
+     * @return static
+     */
+    public static function createForMock(array $result): self
+    {
+        return new self(
+            $result['Enabled'],
+            $result['MFAOptions'],
+            $result['PreferredMfaSetting'] ? UserMFASetting::from($result['PreferredMfaSetting']) : null,
+            AttributeType::create($result['UserAttributes']),
+            $result['UserCreateDate'],
+            $result['UserLastModifiedDate'],
+            UserMFASettingList::create($result['UserMFASettingList'] ?? []),
+            UserStatus::from($result['UserStatus']),
+            $result['Username'],
+        );
+    }
+}

src/app/Aws/CognitoIdentityProvider/AdminGetUser/AwsAdminGetUser.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Aws\CognitoIdentityProvider\AdminGetUser;
+
+use Aws\CognitoIdentityProvider\CognitoIdentityProviderClient;
+use Illuminate\Support\Facades\Log;
+use JsonException;
+
+final readonly class AwsAdminGetUser implements AdminGetUser
+{
+    public function __construct(private CognitoIdentityProviderClient $client)
+    {
+    }
+
+    /**
+     * @param AdminGetUserPayload $payload
+     * @return AdminGetUserResult
+     * @throws JsonException
+     */
+    public function execute(AdminGetUserPayload $payload): AdminGetUserResult
+    {
+        Log::debug(get_class($payload), json_decode(json_encode($payload, JSON_THROW_ON_ERROR), true, 512, JSON_THROW_ON_ERROR));
+
+        $awsResult = $this->client->adminGetUser([
+            'UserPoolId' => $payload->userPoolId,
+            'Username' => $payload->username,
+        ]);
+
+        $result = AdminGetUserResult::createForAws($awsResult);
+
+        Log::debug(get_class($result), json_decode(json_encode($result, JSON_THROW_ON_ERROR), true, 512, JSON_THROW_ON_ERROR));
+
+        return $result;
+    }
+}

src/app/Aws/CognitoIdentityProvider/AdminGetUser/MockAdminGetUser.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Aws\CognitoIdentityProvider\AdminGetUser;
+
+use Carbon\Carbon;
+use Illuminate\Support\Str;
+
+final class MockAdminGetUser implements AdminGetUser
+{
+    /**
+     * @param AdminGetUserPayload $payload
+     * @return AdminGetUserResult
+     */
+    public function execute(AdminGetUserPayload $payload): AdminGetUserResult
+    {
+        return AdminGetUserResult::createForMock([
+            'Attributes' => [
+                [
+                    'Name' => 'sub',
+                    'Value' => (string) Str::uuid(),
+                ],
+            ],
+            'Enabled' => true,
+            'MFAOptions' => [],
+            'UserCreateDate' => Carbon::now(),
+            'UserLastModifiedDate' => Carbon::now(),
+            'UserStatus' => 'FORCE_CHANGE_PASSWORD',
+            'Username' => 'mock-user',
+        ]);
+    }
+}

src/app/Aws/CognitoType/UserMFASetting.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Aws\CognitoType;
+
+enum UserMFASetting: string
+{
+    case SMS_MFA = 'SMS_MFA';
+    case SOFTWARE_TOKEN_MFA = 'SOFTWARE_TOKEN_MFA'; // TOTP
+}

src/app/Aws/CognitoType/UserMFASettingList.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Aws\CognitoType;
+
+final readonly class UserMFASettingList
+{
+    private function __construct(public array $attributes)
+    {
+    }
+
+    /**
+     * @param array $attributes
+     * @return static
+     */
+    public static function create(array $attributes): self
+    {
+        return new self(array_map(static fn($attribute) => UserMFASetting::from($attribute), $attributes));
+    }
+
+    /**
+     * 多要素認証登録済みか
+     *
+     * @return bool
+     */
+    public function enabledMfa(): bool
+    {
+        return $this->attributes === [];
+    }
+
+    /**
+     * TOTP認証が有効か
+     *
+     * @return bool
+     */
+    public function enabledTotp(): bool
+    {
+        return in_array(UserMFASetting::SOFTWARE_TOKEN_MFA, $this->attributes, true);
+    }
+
+    /**
+     * SMS認証が有効か
+     *
+     * @return bool
+     */
+    public function enabledSms(): bool
+    {
+        return in_array(UserMFASetting::SMS_MFA, $this->attributes, true);
+    }
+}

src/app/Aws/CognitoType/UserStatus.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Aws\CognitoType;
+
+enum UserStatus: string
+{
+    case UNCONFIRMED = 'UNCONFIRMED'; // ユーザーは作成されましたが、確認されていません。
+    case CONFIRMED = 'CONFIRMED'; // ユーザーが確認されました。
+    case ARCHIVED = 'ARCHIVED'; // ユーザーはもうアクティブではありません。
+    case UNKNOWN = 'UNKNOWN'; // ユーザーのステータスが不明です。
+    case RESET_REQUIRED = 'RESET_REQUIRED'; // ユーザーは確認されていますが、ユーザーはサインインする前にコードを要求し、パスワードをリセットする必要があります。
+    case FORCE_CHANGE_PASSWORD = 'FORCE_CHANGE_PASSWORD'; // ユーザーは確認され、一時パスワードを使用してサインインできますが、最初のサインインでは、他の操作を行う前にパスワードを新しい値に変更する必要があります。
+}