ユーザーアカウントの管理と検索 - Amazon Cognito

ユーザーアカウントの管理と検索

ユーザープールを作成すると、AWS Management Console、AWS Command Line Interface または Amazon Cognito API を使用してユーザーを表示し、管理することができます。このトピックでは、AWS Management Console を使用してユーザーを表示および検索する方法について説明します。

ユーザー属性の表示

Amazon Cognito コンソールでユーザー属性を表示するには、以下の手順に従います。

Original console

コンソールで実行することができるオペレーションは多くあります(AWS Management Console)。

  • [プールの詳細] を表示し、ユーザープールの属性、パスワードポリシー、MFA 設定、アプリ、トリガーを編集できます。詳細については、「ユーザープールリファレンス (AWS Management Console)」を参照してください。

  • ユーザープール内のユーザーを表示し、詳細についてさらに調べることができます。

  • また、ユーザープール内の個々のユーザーの詳細を表示できます。

  • さらに、ユーザープール内のユーザーを検索することもできます。

ユーザー属性を表示するには
  1. AWS Management Console の Amazon Cognito ホームページから [Manage user pools] (ユーザープールの管理) を選択します。

  2. [Your User Pools] (ユーザープール) ページからユーザープールを選択します。

  3. ユーザー情報を表示するには、[ユーザーとグループ] を選択します。

  4. 個々のユーザーについての詳細を表示するには、ユーザー名を選択します。この画面から、以下のどのアクションでも実行できます:

    • ユーザーをグループに追加

    • ユーザーパスワードのリセット

    • ユーザーの確認

    • MFA の有効化または無効化

    • ユーザーの削除

New console
ユーザー属性を表示するには
  1. Amazon Cognito コンソールに移動します。プロンプトが表示されたら、AWS 認証情報を入力します。

  2. [User Pools] (ユーザープール) を選択します。

  3. リストから存在するユーザープールを 1 つ選択します。

  4. [Users] (ユーザー) タブをクリックし、リストからユーザーを選択します。

  5. ユーザーの詳細ページの [User attributes] (ユーザー属性) で、ユーザーに関連付けられている属性を表示できます。

ユーザーのパスワードのリセット

Amazon Cognito コンソールでユーザーのパスワードをリセットするには、以下の手順に従います。

Original console
ユーザーのパスワードのリセット
  1. AWS Management Console の Amazon Cognito ホームページから [Manage user pools] (ユーザープールの管理) を選択します。

  2. [Your User Pools] (ユーザープール) ページからユーザープールを選択します。

  3. ユーザー情報を表示するには、[ユーザーとグループ] を選択します。

  4. リストから、パスワードをリセットするユーザーを選択します。

    [Reset user password] (ユーザーパスワードのリセット) アクションを使用すると、確認コードがユーザーに即時送信され、ユーザーの状態が RESET_REQUIRED に変更されることでユーザーの現在のパスワードが無効にされます。[MFA の有効化] アクションを実行すると、ユーザーがログインしようとしたときに確認コードがユーザーに送信されます。[ユーザーパスワードのリセット] コードは、1 時間有効です。MFA コードは 3 分間有効です。

New console
ユーザーのパスワードのリセット
  1. Amazon Cognito コンソールに移動します。プロンプトが表示されたら、AWS 認証情報を入力します。

  2. [User Pools] (ユーザープール) を選択します。

  3. リストから存在するユーザープールを 1 つ選択します。

  4. [Users] (ユーザー) タブをクリックし、リストからユーザーを選択します。

  5. ユーザーの詳細ページで、[Actions] (アクション)、[Reset password] (パスワードのリセット) を選択します。

  6. [Reset password] (パスワードのリセット) ダイアログで、情報を確認し、準備ができたら [Reset] (リセット) を選択します。

    この行動により、確認コードがユーザーに即時送信され、ユーザーの状態が RESET_REQUIRED に変更されることでユーザーの現在のパスワードが無効にされます。[Reset password] (ユーザーパスワードのリセット) コードは、1 時間有効です。

ユーザー属性の検索

ユーザープールがすでに作成されている場合は、AWS Management Consoleの [Users] (ユーザー) パネルから検索できます。また、[Filter] (フィルター) パラメータを受け入れる Amazon Cognitoの ListUsers API も使用できます。

以下のどの標準属性でも検索できます。カスタム属性は検索できません。

  • username (大文字と小文字が区別されます)

  • email

  • phone_number

  • name

  • given_name

  • family_name

  • preferred_username

  • cognito:user_status (コンソールでは [Status (ステータス)] となっています) (大文字と小文字が区別されません)

  • status (コンソールでは [Enabled (有効)] となっています) (大文字と小文字が区別されます)

  • sub

注記

また、クライアント側のフィルターを使用してユーザーを一覧表示することもできます。サーバー側のフィルターは、1 つ以上の属性に一致しません。高度な検索を行うには、AWS Command Line Interface での list-users のアクションの --query パラメータを用いたクライアント側のフィルターを使用します。クライアント側のフィルターを使用すると、ListUsers は 0 人以上のユーザーからなるページ分割されたリストを返します。結果がゼロで、複数のページを連続して受信できます。Null ページネーショントークン値を受け取るまで、返される各ページネーショントークンでクエリを繰り返し、組み合わせた結果を確認します。

サーバー側とクライアント側のフィルタリングの詳細については、ユーザーガイドの「AWS Command Line Interface での AWS CLI 出力の フィルタリング」を参照してください。

AWS Management Console を使用したユーザーの検索

ユーザープールがすでに作成されている場合は、AWS Management Consoleの [Users] (ユーザー) パネルから検索できます。

AWS Management Console は、常にプレフィックス ("先頭の文字") 検索を行います。

Original console

以下の例はすべて、同じユーザープールを使用します。

たとえば、すべてのユーザーをリストする場合、検索ボックスを空のままにします。


              すべてのユーザーをリストするには、検索ボックスを空のままにする。

すべての確認済みユーザーを検索する場合は、ドロップダウンメニューから [Status (ステータス)] を選択します。検索ボックスに、「confirmed」という語の先頭の文字を入力します。


              すべての確認済みユーザーをリストするには、[Status] (ステータス) を選択し、「confirmed」(確認済み) という語の先頭の文字を入力します。

[ユーザー名] など、一部の属性値では、大文字と小文字が区別される点に注意してください。


              大文字と小文字が区別される属性で文字の大きさを間違った場合、その属性値は一致しません。
New console
Amazon Cognito コンソールでユーザーを検索する
  1. Amazon Cognito コンソールに移動します。AWS 認証情報を求められる場合があります。

  2. [User Pools] (ユーザープール) を選択します。

  3. リストから存在するユーザープールを 1 つ選択します。

  4. [Users] (ユーザー) タブを選択し、検索フィールドに、ユーザーのユーザーネームを入力します。[Username] (ユーザーネーム) など、一部の属性値では、大文字と小文字が区別される点に注意してください。

    また、検索フィルターを調整して、スコープを他のユーザープロパティ ([Email] (E メール)、[Phone number] (電話番号)、または [Last name] (姓)など) に絞り込むことで、ユーザーを検索することもできます。

ListUsers API を使用したユーザーの検索

アプリからユーザーを検索するには、Amazon Cognito の ListUsers API を使用します。この API は以下のパラメータを使用します。

  • AttributesToGet: 文字列の配列です。各文字列は、検索結果でユーザーごとに返されるユーザー属性の名前です。配列が空の場合、すべての属性が返されます。

  • Filter: 「 ""」形式のフィルター文字列です。AttributeNameFilter-TypeAttributeValueフィルター文字列内の引用符は、円記号 (\) を使用してエスケープする必要があります。例えば、"family_name = \"Reddy\"" です。フィルター文字列が空の場合、ListUsers はユーザープールのすべてのユーザーを返します。

    • AttributeName: 検索する属性の名前。同時に検索できる属性は 1 つのみです。

      注記

      標準属性のみを検索できます。カスタム属性は検索できません。これはインデックスが付けられた属性のみが検索可能なためで、カスタム属性にインデックスを作成することはできません。

    • Filter-Type: 完全一致を検索する場合は、= を使用します (given_name = "Jon" など)。プレフィックス (「先頭の文字」) 一致を検索する場合、^= を使用します (given_name ^= "Jon" など)。

    • AttributeValue: ユーザーごとに一致する必要がある属性値です。

  • Limit: 返されるユーザーの最大数です。

  • PaginationToken: 前の検索からさらに結果を取得するためのトークンです。Amazon Cognito は 1 時間後にページ分割トークンを期限切れにします。

  • UserPoolId: 検索を実行する必要があるユーザープールのユーザープール ID です。

すべての検索で大文字と小文字が区別されません。検索結果は、AttributeName 文字列により指定された属性によって昇順に並べ替えられます。

ListUsers API の使用例

次の例はすべてのユーザーを返します。すべての属性が含まれています。

{ "AttributesToGet": [], "Filter": "", "Limit": 10, "UserPoolId": "us-east-1_samplepool" }

次の例は、電話番号の先頭が「+1312」のすべてのユーザーを返します。また、すべての属性が含まれています。

{ "AttributesToGet": [], "Filter": "phone_number ^= \"+1312\"", "Limit": 10, "UserPoolId": "us-east-1_samplepool" }

次の例は、姓が「Reddy」の先頭 10 人のユーザーを返します。各ユーザーの検索結果には、ユーザーの名、電話番号、E メールアドレスが含まれています。ユーザープールに存在する一致ユーザーが 10 人を超える場合、レスポンスにはページ分割トークンが含まれています。

{ "AttributesToGet": [ "given_name", "phone_number", "email" ], "Filter": "family_name = \"Reddy\"", "Limit": 10, "UserPoolId": "us-east-1_samplepool" }

前の例でページ分割トークンが返された場合、次の例は同じフィルター文字列と一致する次の 10 人のユーザーを返します。

{ "AttributesToGet": [ "given_name", "phone_number", "email" ], "Filter": "family_name = \"Reddy\"", "Limit": 10, "PaginationToken": "pagination_token_from_previous_search", "UserPoolId": "us-east-1_samplepool" }