を使用した Amazon Cognito ID プロバイダーの例 AWS CLI - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

を使用した Amazon Cognito ID プロバイダーの例 AWS CLI

次のコード例は、Amazon Cognito ID プロバイダー AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、関連するシナリオやサービス間の例ではアクションのコンテキストが確認できます。

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

各例には、 へのリンクが含まれています。このリンクには GitHub、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

次の例は、add-custom-attributes を使用する方法を説明しています。

AWS CLI

カスタム属性を追加するには

この例では、カスタム属性 CustomAttr1 をユーザープールに追加します。これは文字列型で、最低 1 文字、最大 15 文字が必要です。この値は必須ではありません。

コマンド:

aws cognito-idp add-custom-attributes --user-pool-id us-west-2_aaaaaaaaa --custom-attributes Name="CustomAttr1",AttributeDataType="String",DeveloperOnlyAttribute=false,Required=false,StringAttributeConstraints="{MinLength=1,MaxLength=15}"
  • API の詳細については、「 コマンドリファレンスAddCustomAttributes」の「」を参照してください。 AWS CLI

次の例は、admim-disable-user を使用する方法を説明しています。

AWS CLI

ユーザーを無効にするには

この例では、ユーザー jane@example.com を無効にします。

コマンド:

aws cognito-idp admin-disable-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com
  • API の詳細については、「 コマンドリファレンスAdmimDisableUser」の「」を参照してください。 AWS CLI

次の例は、admim-enable-user を使用する方法を説明しています。

AWS CLI

ユーザーを有効にするには

この例では、ユーザー名 jane@example.com を有効にします。

コマンド:

aws cognito-idp admin-enable-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com
  • API の詳細については、「 コマンドリファレンスAdmimEnableUser」の「」を参照してください。 AWS CLI

次の例は、admin-add-user-to-group を使用する方法を説明しています。

AWS CLI

ユーザーをグループに追加するには

この例では、ユーザー Jane をグループ に追加します MyGroup。

コマンド:

aws cognito-idp admin-add-user-to-group --user-pool-id us-west-2_aaaaaaaaa --username Jane --group-name MyGroup
  • API の詳細については、「 コマンドリファレンスAdminAddUserToGroup」の「」を参照してください。 AWS CLI

次の例は、admin-confirm-sign-up を使用する方法を説明しています。

AWS CLI

ユーザー登録を確認するには

この例では、ユーザー jane@example.com を確認します。

コマンド:

aws cognito-idp admin-confirm-sign-up --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com
  • API の詳細については、「 コマンドリファレンスAdminConfirmSignUp」の「」を参照してください。 AWS CLI

次の例は、admin-create-user を使用する方法を説明しています。

AWS CLI

ユーザーを作成するには

次のadmin-create-user例では、指定された設定の E メールアドレスと電話番号を持つユーザーを作成します。

aws cognito-idp admin-create-user \ --user-pool-id us-west-2_aaaaaaaaa \ --username diego \ --user-attributes Name=email,Value=diego@example.com Name=phone_number,Value="+15555551212" \ --message-action SUPPRESS

出力:

{ "User": { "Username": "diego", "Attributes": [ { "Name": "sub", "Value": "7325c1de-b05b-4f84-b321-9adc6e61f4a2" }, { "Name": "phone_number", "Value": "+15555551212" }, { "Name": "email", "Value": "diego@example.com" } ], "UserCreateDate": 1548099495.428, "UserLastModifiedDate": 1548099495.428, "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD" } }
  • API の詳細については、「 コマンドリファレンスAdminCreateUser」の「」を参照してください。 AWS CLI

次の例は、admin-delete-user-attributes を使用する方法を説明しています。

AWS CLI

ユーザー属性を削除するには

この例では、ユーザー diego@example.com のカスタム属性 CustomAttr1 を削除します。

コマンド:

aws cognito-idp admin-delete-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attribute-names "custom:CustomAttr1"
  • API の詳細については、「 コマンドリファレンスAdminDeleteUserAttributes」の「」を参照してください。 AWS CLI

次の例は、admin-delete-user を使用する方法を説明しています。

AWS CLI

ユーザーを削除するには

この例では、ユーザーを削除します。

コマンド:

aws cognito-idp admin-delete-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com
  • API の詳細については、「 コマンドリファレンスAdminDeleteUser」の「」を参照してください。 AWS CLI

次の例は、admin-forget-device を使用する方法を説明しています。

AWS CLI

デバイスを忘れた場合

この例では、ユーザー名 jane@example.com のデバイスを忘れました

コマンド:

aws cognito-idp admin-forget-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678
  • API の詳細については、「 コマンドリファレンスAdminForgetDevice」の「」を参照してください。 AWS CLI

次の例は、admin-get-device を使用する方法を説明しています。

AWS CLI

デバイスを取得するには

この例では、ユーザー名 jane@example.com のデバイスを取得します。

コマンド:

aws cognito-idp admin-get-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678
  • API の詳細については、「 コマンドリファレンスAdminGetDevice」の「」を参照してください。 AWS CLI

次の例は、admin-get-user を使用する方法を説明しています。

AWS CLI

ユーザーを取得するには

この例では、ユーザー名 jane@example.com に関する情報を取得します。

コマンド:

aws cognito-idp admin-get-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com

出力:

{ "Username": "4320de44-2322-4620-999b-5e2e1c8df013", "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD", "UserCreateDate": 1548108509.537, "UserAttributes": [ { "Name": "sub", "Value": "4320de44-2322-4620-999b-5e2e1c8df013" }, { "Name": "email_verified", "Value": "true" }, { "Name": "phone_number_verified", "Value": "true" }, { "Name": "phone_number", "Value": "+01115551212" }, { "Name": "email", "Value": "jane@example.com" } ], "UserLastModifiedDate": 1548108509.537 }
  • API の詳細については、「 コマンドリファレンスAdminGetUser」の「」を参照してください。 AWS CLI

次の例は、admin-initiate-auth を使用する方法を説明しています。

AWS CLI

認証を開始するには

この例では、ユーザー名 jane@example.com の ADMIN_NO_SRP_AUTH フローを使用して認証を開始します。

クライアントでは、サーバーベースの認証用のサインイン API (ADMIN_NO_SRP_AUTH) が有効になっている必要があります。

戻り値のセッション情報を使用して admin-respond-to-auth-challenge を呼び出します。

コマンド:

aws cognito-idp admin-initiate-auth --user-pool-id us-west-2_aaaaaaaaa --client-id 3n4b5urk1ft4fl3mg5e62d9ado --auth-flow ADMIN_NO_SRP_AUTH --auth-parameters USERNAME=jane@example.com,PASSWORD=password

出力:

{ "ChallengeName": "NEW_PASSWORD_REQUIRED", "Session": "SESSION", "ChallengeParameters": { "USER_ID_FOR_SRP": "84514837-dcbc-4af1-abff-f3c109334894", "requiredAttributes": "[]", "userAttributes": "{\"email_verified\":\"true\",\"phone_number_verified\":\"true\",\"phone_number\":\"+01xxx5550100\",\"email\":\"jane@example.com\"}" } }
  • API の詳細については、「 コマンドリファレンスAdminInitiateAuth」の「」を参照してください。 AWS CLI

次の例は、admin-list-devices を使用する方法を説明しています。

AWS CLI

ユーザーのデバイスを一覧表示するには

この例では、ユーザー名 jane@example.com のデバイスを一覧表示します。

コマンド:

aws cognito-idp admin-list-devices --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com
  • API の詳細については、「 コマンドリファレンスAdminListDevices」の「」を参照してください。 AWS CLI

次の例は、admin-list-groups-for-user を使用する方法を説明しています。

AWS CLI

ユーザーのグループを一覧表示するには

この例では、ユーザー名 jane@example.com のグループを一覧表示します。

コマンド:

aws cognito-idp admin-list-groups-for-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com

出力:

{ "Groups": [ { "Description": "Sample group", "Precedence": 1, "LastModifiedDate": 1548097827.125, "RoleArn": "arn:aws:iam::111111111111:role/SampleRole", "GroupName": "SampleGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "CreationDate": 1548097827.125 } ] }
  • API の詳細については、「 コマンドリファレンスAdminListGroupsForUser」の「」を参照してください。 AWS CLI

次の例は、admin-list-user-auth-events を使用する方法を説明しています。

AWS CLI

ユーザーの承認イベントを一覧表示するには

この例では、ユーザー名 diego@example.com の承認イベントを一覧表示します。

コマンド:

aws cognito-idp admin-list-user-auth-events --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com
  • API の詳細については、「 コマンドリファレンスAdminListUserAuthEvents」の「」を参照してください。 AWS CLI

次の例は、admin-remove-user-from-group を使用する方法を説明しています。

AWS CLI

グループからユーザーを削除するには

この例では、jane@example.com を から削除します SampleGroup。

コマンド:

aws cognito-idp admin-remove-user-from-group --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --group-name SampleGroup
  • API の詳細については、「 コマンドリファレンスAdminRemoveUserFromGroup」の「」を参照してください。 AWS CLI

次の例は、admin-reset-user-password を使用する方法を説明しています。

AWS CLI

ユーザーパスワードをリセットするには

この例では、diego@example.com のパスワードをリセットします。

コマンド:

aws cognito-idp admin-reset-user-password --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com
  • API の詳細については、「 コマンドリファレンスAdminResetUserPassword」の「」を参照してください。 AWS CLI

次の例は、admin-set-user-mfa-preference を使用する方法を説明しています。

AWS CLI

ユーザー MFA 設定を指定するには

この例では、ユーザー名 diego@example.com の SMS MFA 設定を設定します。

コマンド:

aws cognito-idp admin-set-user-mfa-preference --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --sms-mfa-settings Enabled=false,PreferredMfa=false
  • API の詳細については、「 コマンドリファレンスAdminSetUserMfaPreference」の「」を参照してください。 AWS CLI

次の例は、admin-set-user-settings を使用する方法を説明しています。

AWS CLI

ユーザー設定を行うには

この例では、ユーザー名 diego@example.com の MFA 配信設定を EMAIL に設定します。

コマンド:

aws cognito-idp admin-set-user-settings --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --mfa-options DeliveryMedium=EMAIL
  • API の詳細については、「 コマンドリファレンスAdminSetUserSettings」の「」を参照してください。 AWS CLI

次の例は、admin-update-auth-event-feedback を使用する方法を説明しています。

AWS CLI

承認イベントのフィードバックを提供するには

この例では、event-id によって識別される承認イベントのフィードバック値を Valid に設定します。

コマンド:

aws cognito-idp admin-update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id c2c2cf89-c0d3-482d-aba6-99d78a5b0bfe --feedback-value Valid
  • API の詳細については、「 コマンドリファレンスAdminUpdateAuthEventFeedback」の「」を参照してください。 AWS CLI

次の例は、admin-update-device-status を使用する方法を説明しています。

AWS CLI

デバイスのステータスを更新するには

この例では、device-key によって識別されるデバイスのデバイス記憶ステータスを not_remembered に設定します。

コマンド:

aws cognito-idp admin-update-device-status --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --device-key xxxx --device-remembered-status not_remembered
  • API の詳細については、「 コマンドリファレンスAdminUpdateDeviceStatus」の「」を参照してください。 AWS CLI

次の例は、admin-update-user-attributes を使用する方法を説明しています。

AWS CLI

ユーザー属性を更新するには

この例では、ユーザー diego@example.com のカスタムユーザー属性 CustomAttr1 を更新します。

コマンド:

aws cognito-idp admin-update-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attributes Name="custom:CustomAttr1",Value="Purple"
  • API の詳細については、「 コマンドリファレンスAdminUpdateUserAttributes」の「」を参照してください。 AWS CLI

次の例は、change-password を使用する方法を説明しています。

AWS CLI

パスワードを変更するには

この例では、パスワードを変更します。

コマンド:

aws cognito-idp change-password --previous-password OldPassword --proposed-password NewPassword --access-token ACCESS_TOKEN
  • API の詳細については、「 コマンドリファレンスChangePassword」の「」を参照してください。 AWS CLI

次の例は、confirm-forgot-password を使用する方法を説明しています。

AWS CLI

忘れたパスワードを確認するには

この例では、ユーザー名 diego@example.com を忘れた場合のパスワードを確認します。

コマンド:

aws cognito-idp confirm-forgot-password --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --password PASSWORD --confirmation-code CONF_CODE
  • API の詳細については、「 コマンドリファレンスConfirmForgotPassword」の「」を参照してください。 AWS CLI

次の例は、confirm-sign-up を使用する方法を説明しています。

AWS CLI

サインアップを確認するには

この例では、ユーザー名 diego@example.com のサインアップを確認します。

コマンド:

aws cognito-idp confirm-sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --confirmation-code CONF_CODE
  • API の詳細については、「 コマンドリファレンスConfirmSignUp」の「」を参照してください。 AWS CLI

次の例は、create-group を使用する方法を説明しています。

AWS CLI

グループを作成するには

この例では、説明を含むグループを作成します。

コマンド:

aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroup --description "New group."

出力:

{ "Group": { "GroupName": "MyNewGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New group.", "LastModifiedDate": 1548270073.795, "CreationDate": 1548270073.795 } }

ロールと優先順位を持つグループを作成するには

この例では、説明を含むグループを作成します。また、ロールと優先順位も含まれます。

コマンド:

aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroupWithRole --description "New group with a role." --role-arn arn:aws:iam::111111111111:role/MyNewGroupRole --precedence 2

出力:

{ "Group": { "GroupName": "MyNewGroupWithRole", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New group with a role.", "RoleArn": "arn:aws:iam::111111111111:role/MyNewGroupRole", "Precedence": 2, "LastModifiedDate": 1548270211.761, "CreationDate": 1548270211.761 } }
  • API の詳細については、「 コマンドリファレンスCreateGroup」の「」を参照してください。 AWS CLI

次の例は、create-user-import-job を使用する方法を説明しています。

AWS CLI

ユーザーインポートジョブを作成するには

この例では、 という名前のユーザーインポートジョブを作成します MyImportJob。

ユーザーのインポートの詳細については、「CSV ファイルからユーザープールへのユーザーのインポート」を参照してください。

コマンド:

aws cognito-idp create-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-name MyImportJob --cloud-watch-logs-role-arn arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole

出力:

{ "UserImportJob": { "JobName": "MyImportJob", "JobId": "import-qQ0DCt2fRh", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548271795.471, "Status": "Created", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 } }

署名付き URL を使用して curl を含む .csv ファイルをアップロードします。

コマンド:

curl -v -T "PATH_TO_CSV_FILE" -H "x-amz-server-side-encryption:aws:kms" "PRE_SIGNED_URL"
  • API の詳細については、「 コマンドリファレンスCreateUserImportJob」の「」を参照してください。 AWS CLI

次の例は、create-user-pool-client を使用する方法を説明しています。

AWS CLI

ユーザープールクライアントを作成するには

この例では、USER_PASSWORD_AUTH と ADMIN_NO_SRP_AUTH の 2 つの明示的な認証フローを持つ新しいユーザープールクライアントを作成します。

コマンド:

aws cognito-idp create-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-name MyNewClient --no-generate-secret --explicit-auth-flows "USER_PASSWORD_AUTH" "ADMIN_NO_SRP_AUTH"

出力:

{ "UserPoolClient": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientName": "MyNewClient", "ClientId": "6p3bs000no6a4ue1idruvd05ad", "LastModifiedDate": 1548697449.497, "CreationDate": 1548697449.497, "RefreshTokenValidity": 30, "ExplicitAuthFlows": [ "USER_PASSWORD_AUTH", "ADMIN_NO_SRP_AUTH" ], "AllowedOAuthFlowsUserPoolClient": false } }
  • API の詳細については、「 コマンドリファレンスCreateUserPoolClient」の「」を参照してください。 AWS CLI

次の例は、create-user-pool-domain を使用する方法を説明しています。

AWS CLI

ユーザープールドメインを作成するには

この例では、USER_PASSWORD_AUTH と ADMIN_NO_SRP_AUTH の 2 つの明示的な認証フローを持つ新しいユーザープールドメインを作成します。

コマンド:

aws cognito-idp create-user-pool-domain --user-pool-id us-west-2_aaaaaaaaa --domain my-new-domain
  • API の詳細については、「 コマンドリファレンスCreateUserPoolDomain」の「」を参照してください。 AWS CLI

次の例は、create-user-pool を使用する方法を説明しています。

AWS CLI

最小構成のユーザープールを作成するには

この例では、デフォルト値 MyUserPool を使用して という名前のユーザープールを作成します。必要な属性やアプリケーションクライアントはありません。MFA およびアドバンストセキュリティは無効化されています。

コマンド:

aws cognito-idp create-user-pool --pool-name MyUserPool

出力:

{ "UserPool": { "SchemaAttributes": [ { "Name": "sub", "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": true, "AttributeDataType": "String", "Mutable": false }, { "Name": "name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "given_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "family_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "middle_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "nickname", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "preferred_username", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "profile", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "picture", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "website", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "email", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "email_verified", "Mutable": true }, { "Name": "gender", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "birthdate", "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "zoneinfo", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "locale", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "phone_number", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "phone_number_verified", "Mutable": true }, { "Name": "address", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "updated_at", "NumberAttributeConstraints": { "MinValue": "0" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "Number", "Mutable": true } ], "MfaConfiguration": "OFF", "Name": "MyUserPool", "LastModifiedDate": 1547833345.777, "AdminCreateUserConfig": { "UnusedAccountValidityDays": 7, "AllowAdminCreateUserOnly": false }, "EmailConfiguration": {}, "Policies": { "PasswordPolicy": { "RequireLowercase": true, "RequireSymbols": true, "RequireNumbers": true, "MinimumLength": 8, "RequireUppercase": true } }, "CreationDate": 1547833345.777, "EstimatedNumberOfUsers": 0, "Id": "us-west-2_aaaaaaaaa", "LambdaConfig": {} } }

2 つの必須属性でユーザープールを作成するには

この例では、ユーザープール を作成します MyUserPool。プールは、E メールをユーザー名属性として受け入れるように設定されています。また、Amazon Simple Email Service を使用して、E メールの送信元アドレスを検証済みのアドレスに設定します。

コマンド:

aws cognito-idp create-user-pool --pool-name MyUserPool --username-attributes "email" --email-configuration=SourceArn="arn:aws:ses:us-east-1:111111111111:identity/jane@example.com",ReplyToEmailAddress="jane@example.com"

出力:

{ "UserPool": { "SchemaAttributes": [ { "Name": "sub", "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": true, "AttributeDataType": "String", "Mutable": false }, { "Name": "name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "given_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "family_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "middle_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "nickname", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "preferred_username", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "profile", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "picture", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "website", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "email", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "email_verified", "Mutable": true }, { "Name": "gender", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "birthdate", "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "zoneinfo", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "locale", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "phone_number", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "phone_number_verified", "Mutable": true }, { "Name": "address", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "updated_at", "NumberAttributeConstraints": { "MinValue": "0" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "Number", "Mutable": true } ], "MfaConfiguration": "OFF", "Name": "MyUserPool", "LastModifiedDate": 1547837788.189, "AdminCreateUserConfig": { "UnusedAccountValidityDays": 7, "AllowAdminCreateUserOnly": false }, "EmailConfiguration": { "ReplyToEmailAddress": "jane@example.com", "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/jane@example.com" }, "Policies": { "PasswordPolicy": { "RequireLowercase": true, "RequireSymbols": true, "RequireNumbers": true, "MinimumLength": 8, "RequireUppercase": true } }, "UsernameAttributes": [ "email" ], "CreationDate": 1547837788.189, "EstimatedNumberOfUsers": 0, "Id": "us-west-2_aaaaaaaaa", "LambdaConfig": {} } }
  • API の詳細については、「 コマンドリファレンスCreateUserPool」の「」を参照してください。 AWS CLI

次の例は、delete-group を使用する方法を説明しています。

AWS CLI

グループを削除するには

この例では、グループを削除します。

コマンド:

aws cognito-idp delete-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroupName
  • API の詳細については、「 コマンドリファレンスDeleteGroup」の「」を参照してください。 AWS CLI

次の例は、delete-identity-provider を使用する方法を説明しています。

AWS CLI

ID プロバイダーを削除するには

この例では、ID プロバイダーを削除します。

コマンド:

aws cognito-idp delete-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook
  • API の詳細については、「 コマンドリファレンスDeleteIdentityProvider」の「」を参照してください。 AWS CLI

次の例は、delete-resource-server を使用する方法を説明しています。

AWS CLI

リソースサーバーを削除するには

この例では、weather.example.com という名前のリソースサーバーを削除します。

コマンド:

aws cognito-idp delete-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com
  • API の詳細については、「 コマンドリファレンスDeleteResourceServer」の「」を参照してください。 AWS CLI

次の例は、delete-user-attributes を使用する方法を説明しています。

AWS CLI

ユーザー属性を削除するには

この例では、ユーザー属性「FAVORITE_ANIMAL」を削除します。

コマンド:

aws cognito-idp delete-user-attributes --access-token ACCESS_TOKEN --user-attribute-names "FAVORITE_ANIMAL"
  • API の詳細については、「 コマンドリファレンスDeleteUserAttributes」の「」を参照してください。 AWS CLI

次の例は、delete-user-pool-client を使用する方法を説明しています。

AWS CLI

ユーザープールクライアントを削除するには

この例では、ユーザープールクライアントを削除します。

コマンド:

aws cognito-idp delete-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0
  • API の詳細については、「 コマンドリファレンスDeleteUserPoolClient」の「」を参照してください。 AWS CLI

次の例は、delete-user-pool-domain を使用する方法を説明しています。

AWS CLI

ユーザープールドメインを削除するには

次のdelete-user-pool-domain例では、 という名前のユーザープールドメインを削除します。 my-domain

aws cognito-idp delete-user-pool-domain \ --user-pool-id us-west-2_aaaaaaaaa \ --domain my-domain
  • API の詳細については、「 コマンドリファレンスDeleteUserPoolDomain」の「」を参照してください。 AWS CLI

次の例は、delete-user-pool を使用する方法を説明しています。

AWS CLI

ユーザープールを削除するには

この例では、ユーザープール ID、us-west-2_aaaaaaaaaaaaaaaaaaaaa を使用してユーザープールを削除します。

コマンド:

aws cognito-idp delete-user-pool --user-pool-id us-west-2_aaaaaaaaa
  • API の詳細については、「 コマンドリファレンスDeleteUserPool」の「」を参照してください。 AWS CLI

次の例は、delete-user を使用する方法を説明しています。

AWS CLI

ユーザーを削除するには

この例では、ユーザーを削除します。

コマンド:

aws cognito-idp delete-user --access-token ACCESS_TOKEN
  • API の詳細については、「 コマンドリファレンスDeleteUser」の「」を参照してください。 AWS CLI

次の例は、describe-identity-provider を使用する方法を説明しています。

AWS CLI

ID プロバイダーを記述するには

この例では、Facebook という名前の ID プロバイダーについて説明します。

コマンド:

aws cognito-idp describe-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook

出力:

{ "IdentityProvider": { "UserPoolId": "us-west-2_aaaaaaaaa", "ProviderName": "Facebook", "ProviderType": "Facebook", "ProviderDetails": { "attributes_url": "https://graph.facebook.com/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": myscope", "authorize_url": "https://www.facebook.com/v2.9/dialog/oauth", "client_id": "11111", "client_secret": "11111", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v2.9/oauth/access_token" }, "AttributeMapping": { "username": "id" }, "IdpIdentifiers": [], "LastModifiedDate": 1548105901.736, "CreationDate": 1548105901.736 } }
  • API の詳細については、「 コマンドリファレンスDescribeIdentityProvider」の「」を参照してください。 AWS CLI

次の例は、describe-resource-server を使用する方法を説明しています。

AWS CLI

リソースサーバーを記述するには

この例では、リソースサーバー weather.example.com について説明します。

コマンド:

aws cognito-idp describe-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com

出力:

{ "ResourceServer": { "UserPoolId": "us-west-2_aaaaaaaaa", "Identifier": "weather.example.com", "Name": "Weather", "Scopes": [ { "ScopeName": "weather.update", "ScopeDescription": "Update weather forecast" }, { "ScopeName": "weather.read", "ScopeDescription": "Read weather forecasts" }, { "ScopeName": "weather.delete", "ScopeDescription": "Delete a weather forecast" } ] } }
  • API の詳細については、「 コマンドリファレンスDescribeResourceServer」の「」を参照してください。 AWS CLI

次の例は、describe-risk-configuration を使用する方法を説明しています。

AWS CLI

リスク設定を記述するには

この例では、プール us-west-2_aaaaaaaaaaaaaaaaaa に関連するリスク設定について説明します。

コマンド:

aws cognito-idp describe-risk-configuration --user-pool-id us-west-2_aaaaaaaaa

出力:

{ "RiskConfiguration": { "UserPoolId": "us-west-2_aaaaaaaaa", "CompromisedCredentialsRiskConfiguration": { "EventFilter": [ "SIGN_IN", "SIGN_UP", "PASSWORD_CHANGE" ], "Actions": { "EventAction": "BLOCK" } }, "AccountTakeoverRiskConfiguration": { "NotifyConfiguration": { "From": "diego@example.com", "ReplyTo": "diego@example.com", "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/diego@example.com", "BlockEmail": { "Subject": "Blocked sign-in attempt", "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "NoActionEmail": { "Subject": "New sign-in attempt", "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "MfaEmail": { "Subject": "New sign-in attempt", "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" } }, "Actions": { "LowAction": { "Notify": true, "EventAction": "NO_ACTION" }, "MediumAction": { "Notify": true, "EventAction": "MFA_IF_CONFIGURED" }, "HighAction": { "Notify": true, "EventAction": "MFA_IF_CONFIGURED" } } } } }
  • API の詳細については、「 コマンドリファレンスDescribeRiskConfiguration」の「」を参照してください。 AWS CLI

次の例は、describe-user-import-job を使用する方法を説明しています。

AWS CLI

ユーザーインポートジョブを記述するには

この例では、ユーザー入力ジョブについて説明します。

ユーザーのインポートの詳細については、「CSV ファイルからユーザープールへのユーザーのインポート」を参照してください。

コマンド:

aws cognito-idp describe-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW

出力:

{ "UserImportJob": { "JobName": "import-Test1", "JobId": "import-TZqNQvDRnW", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED URL", "CreationDate": 1548271708.512, "Status": "Created", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 } }
  • API の詳細については、「 コマンドリファレンスDescribeUserImportJob」の「」を参照してください。 AWS CLI

次の例は、describe-user-pool-client を使用する方法を説明しています。

AWS CLI

ユーザープールクライアントを記述するには

この例では、ユーザープールクライアントについて説明します。

コマンド:

aws cognito-idp describe-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0

出力:

{ "UserPoolClient": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientName": "MyApp", "ClientId": "38fjsnc484p94kpqsnet7mpld0", "ClientSecret": "CLIENT_SECRET", "LastModifiedDate": 1548108676.163, "CreationDate": 1548108676.163, "RefreshTokenValidity": 30, "ReadAttributes": [ "address", "birthdate", "custom:CustomAttr1", "custom:CustomAttr2", "email", "email_verified", "family_name", "gender", "given_name", "locale", "middle_name", "name", "nickname", "phone_number", "phone_number_verified", "picture", "preferred_username", "profile", "updated_at", "website", "zoneinfo" ], "WriteAttributes": [ "address", "birthdate", "custom:CustomAttr1", "custom:CustomAttr2", "email", "family_name", "gender", "given_name", "locale", "middle_name", "name", "nickname", "phone_number", "picture", "preferred_username", "profile", "updated_at", "website", "zoneinfo" ], "ExplicitAuthFlows": [ "ADMIN_NO_SRP_AUTH", "USER_PASSWORD_AUTH" ], "AllowedOAuthFlowsUserPoolClient": false } }
  • API の詳細については、「 コマンドリファレンスDescribeUserPoolClient」の「」を参照してください。 AWS CLI

次の例は、describe-user-pool-domain を使用する方法を説明しています。

AWS CLI

ユーザープールクライアントを記述するには

この例では、my-domain という名前のユーザープールドメインについて説明します。

コマンド:

aws cognito-idp describe-user-pool-domain --domain my-domain

出力:

{ "DomainDescription": { "UserPoolId": "us-west-2_aaaaaaaaa", "AWSAccountId": "111111111111", "Domain": "my-domain", "S3Bucket": "aws-cognito-prod-pdx-assets", "CloudFrontDistribution": "aaaaaaaaaaaaa.cloudfront.net", "Version": "20190128175402", "Status": "ACTIVE", "CustomDomainConfig": {} } }
  • API の詳細については、「 コマンドリファレンスDescribeUserPoolDomain」の「」を参照してください。 AWS CLI

次の例は、describe-user-pool を使用する方法を説明しています。

AWS CLI

ユーザープールを記述するには

この例では、ユーザープール ID が us-west-2_aaaaaaaaaaaaaaa のユーザープールについて説明します。

コマンド:

aws cognito-idp describe-user-pool --user-pool-id us-west-2_aaaaaaaaa

出力:

{ "UserPool": { "SmsVerificationMessage": "Your verification code is {####}. ", "SchemaAttributes": [ { "Name": "sub", "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": true, "AttributeDataType": "String", "Mutable": false }, { "Name": "name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "given_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "family_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "middle_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "nickname", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "preferred_username", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "profile", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "picture", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "website", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "email", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": true, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "email_verified", "Mutable": true }, { "Name": "gender", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "birthdate", "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "zoneinfo", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "locale", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "phone_number", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "phone_number_verified", "Mutable": true }, { "Name": "address", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "updated_at", "NumberAttributeConstraints": { "MinValue": "0" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "Number", "Mutable": true } ], "EmailVerificationSubject": "Your verification code", "MfaConfiguration": "OFF", "Name": "MyUserPool", "EmailVerificationMessage": "Your verification code is {####}. ", "SmsAuthenticationMessage": "Your authentication code is {####}. ", "LastModifiedDate": 1547763720.822, "AdminCreateUserConfig": { "InviteMessageTemplate": { "EmailMessage": "Your username is {username} and temporary password is {####}. ", "EmailSubject": "Your temporary password", "SMSMessage": "Your username is {username} and temporary password is {####}. " }, "UnusedAccountValidityDays": 7, "AllowAdminCreateUserOnly": false }, "EmailConfiguration": { "ReplyToEmailAddress": "myemail@mydomain.com" "SourceArn": "arn:aws:ses:us-east-1:000000000000:identity/myemail@mydomain.com" }, "AutoVerifiedAttributes": [ "email" ], "Policies": { "PasswordPolicy": { "RequireLowercase": true, "RequireSymbols": true, "RequireNumbers": true, "MinimumLength": 8, "RequireUppercase": true } }, "UserPoolTags": {}, "UsernameAttributes": [ "email" ], "CreationDate": 1547763720.822, "EstimatedNumberOfUsers": 1, "Id": "us-west-2_aaaaaaaaa", "LambdaConfig": {} } }
  • API の詳細については、「 コマンドリファレンスDescribeUserPool」の「」を参照してください。 AWS CLI

次の例は、forget-device を使用する方法を説明しています。

AWS CLI

デバイスを忘れた場合

この例では、デバイスを忘れました。

コマンド:

aws cognito-idp forget-device --device-key us-west-2_abcd_1234-5678
  • API の詳細については、「 コマンドリファレンスForgetDevice」の「」を参照してください。 AWS CLI

次の例は、forgot-password を使用する方法を説明しています。

AWS CLI

パスワードの変更を強制するには

次のforgot-password例では、 にメッセージを送信 jane@example.com してパスワードを変更します。

aws cognito-idp forgot-password --client-id 38fjsnc484p94kpqsnet7mpld0 --username jane@example.com

出力:

{ "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } }
  • API の詳細については、「 コマンドリファレンスForgotPassword」の「」を参照してください。 AWS CLI

次の例は、get-csv-header を使用する方法を説明しています。

AWS CLI

csv ヘッダーを作成するには

この例では、csv ヘッダーを作成します。

ユーザーのインポートの詳細については、「CSV ファイルからユーザープールへのユーザーのインポート」を参照してください。

コマンド:

aws cognito-idp get-csv-header --user-pool-id us-west-2_aaaaaaaaa

出力:

{ "UserPoolId": "us-west-2_aaaaaaaaa", "CSVHeader": [ "name", "given_name", "family_name", "middle_name", "nickname", "preferred_username", "profile", "picture", "website", "email", "email_verified", "gender", "birthdate", "zoneinfo", "locale", "phone_number", "phone_number_verified", "address", "updated_at", "cognito:mfa_enabled", "cognito:username" ] }

... CSV ファイルからユーザープールへのユーザーのインポート: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html

  • API の詳細については、「 コマンドリファレンスGetCsvHeader」の「」を参照してください。 AWS CLI

次の例は、get-group を使用する方法を説明しています。

AWS CLI

グループに関する情報を取得するには

この例では、 という名前のグループに関する情報を取得します MyGroup。

コマンド:

aws cognito-idp get-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup

出力:

{ "Group": { "GroupName": "MyGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "A sample group.", "LastModifiedDate": 1548270073.795, "CreationDate": 1548270073.795 } }
  • API の詳細については、「 コマンドリファレンスGetGroup」の「」を参照してください。 AWS CLI

次の例は、get-signing-certificate を使用する方法を説明しています。

AWS CLI

署名証明書を取得するには

この例では、ユーザープールの署名証明書を取得します。

コマンド:

aws cognito-idp get-signing-certificate --user-pool-id us-west-2_aaaaaaaaa

出力:

{ "Certificate": "CERTIFICATE_DATA" }
  • API の詳細については、「 コマンドリファレンスGetSigningCertificate」の「」を参照してください。 AWS CLI

次の例は、get-ui-customization を使用する方法を説明しています。

AWS CLI

UI カスタマイズ情報を取得するには

この例では、ユーザープールの UI カスタマイズ情報を取得します。

コマンド:

aws cognito-idp get-ui-customization --user-pool-id us-west-2_aaaaaaaaa

出力:

{ "UICustomization": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientId": "ALL", "ImageUrl": "https://aaaaaaaaaaaaa.cloudfront.net/us-west-2_aaaaaaaaa/ALL/20190128231240/assets/images/image.jpg", "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n", "CSSVersion": "20190128231240" } }
  • API の詳細については、「 コマンドリファレンスGetUiCustomization」の「」を参照してください。 AWS CLI

次の例は、list-user-import-jobs を使用する方法を説明しています。

AWS CLI

ユーザーインポートジョブを一覧表示するには

この例では、ユーザーインポートジョブを一覧表示します。

ユーザーのインポートの詳細については、「CSV ファイルからユーザープールへのユーザーのインポート」を参照してください。

コマンド:

aws cognito-idp list-user-import-jobs --user-pool-id us-west-2_aaaaaaaaa --max-results 20

出力:

{ "UserImportJobs": [ { "JobName": "Test2", "JobId": "import-d0OnwGA3mV", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548272793.069, "Status": "Created", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 }, { "JobName": "Test1", "JobId": "import-qQ0DCt2fRh", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548271795.471, "Status": "Created", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 }, { "JobName": "import-Test1", "JobId": "import-TZqNQvDRnW", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548271708.512, "StartDate": 1548277247.962, "CompletionDate": 1548277248.912, "Status": "Failed", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 1, "CompletionMessage": "Too many users have failed or been skipped during the import." } ] }
  • API の詳細については、「 コマンドリファレンスListUserImportJobs」の「」を参照してください。 AWS CLI

次の例は、list-user-pools を使用する方法を説明しています。

AWS CLI

ユーザープールを一覧表示するには

次の例では、最大 20 のユーザープールを一覧表示します。

コマンド:

aws cognito-idp list-user-pools --max-results 20

出力:

{ "UserPools": [ { "CreationDate": 1547763720.822, "LastModifiedDate": 1547763720.822, "LambdaConfig": {}, "Id": "us-west-2_aaaaaaaaa", "Name": "MyUserPool" } ] }
  • API の詳細については、「 コマンドリファレンスListUserPools」の「」を参照してください。 AWS CLI

次の例は、list-users-in-group を使用する方法を説明しています。

AWS CLI

グループ内のユーザーを一覧表示するには

この例では、グループ のユーザーを一覧表示します MyGroup。

コマンド:

aws cognito-idp list-users-in-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup

出力:

{ "Users": [ { "Username": "acf10624-80bb-401a-ac61-607bee2110ec", "Attributes": [ { "Name": "sub", "Value": "acf10624-80bb-401a-ac61-607bee2110ec" }, { "Name": "custom:CustomAttr1", "Value": "New Value!" }, { "Name": "email", "Value": "jane@example.com" } ], "UserCreateDate": 1548102770.284, "UserLastModifiedDate": 1548103204.893, "Enabled": true, "UserStatus": "CONFIRMED" }, { "Username": "22704aa3-fc10-479a-97eb-2af5806bd327", "Attributes": [ { "Name": "sub", "Value": "22704aa3-fc10-479a-97eb-2af5806bd327" }, { "Name": "email_verified", "Value": "true" }, { "Name": "email", "Value": "diego@example.com" } ], "UserCreateDate": 1548089817.683, "UserLastModifiedDate": 1548089817.683, "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD" } ] }
  • API の詳細については、「 コマンドリファレンスListUsersInGroup」の「」を参照してください。 AWS CLI

次の例は、list-users を使用する方法を説明しています。

AWS CLI

ユーザーを一覧表示するには

この例では最大 20 のユーザーを一覧表示します。

コマンド:

aws cognito-idp list-users --user-pool-id us-west-2_aaaaaaaaa --limit 20

出力:

{ "Users": [ { "Username": "22704aa3-fc10-479a-97eb-2af5806bd327", "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD", "UserCreateDate": 1548089817.683, "UserLastModifiedDate": 1548089817.683, "Attributes": [ { "Name": "sub", "Value": "22704aa3-fc10-479a-97eb-2af5806bd327" }, { "Name": "email_verified", "Value": "true" }, { "Name": "email", "Value": "mary@example.com" } ] } ] }
  • API の詳細については、「 コマンドリファレンスListUsers」の「」を参照してください。 AWS CLI

次の例は、resend-confirmation-code を使用する方法を説明しています。

AWS CLI

確認コードを再送信するには

次の resend-confirmation-code 例では、ユーザー jane に確認コードを送信します。

aws cognito-idp resend-confirmation-code \ --client-id 12a3b456c7de890f11g123hijk \ --username jane

出力:

{ "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } }

詳細については、「Amazon Cognito デベロッパーガイド」の「ユーザーアカウントのサインアップと確認」を参照してください。

  • API の詳細については、「 コマンドリファレンスResendConfirmationCode」の「」を参照してください。 AWS CLI

次の例は、respond-to-auth-challenge を使用する方法を説明しています。

AWS CLI

認証チャレンジに応答するには

この例では initiate-auth で開始された認証チャレンジに応答します。NEW_PASSWORD_REQUIRED チャレンジへの応答です。ユーザー jane@example.com のパスワードを設定します。

コマンド:

aws cognito-idp respond-to-auth-challenge --client-id 3n4b5urk1ft4fl3mg5e62d9ado --challenge-name NEW_PASSWORD_REQUIRED --challenge-responses USERNAME=jane@example.com,NEW_PASSWORD="password" --session "SESSION_TOKEN"

出力:

{ "ChallengeParameters": {}, "AuthenticationResult": { "AccessToken": "ACCESS_TOKEN", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "REFRESH_TOKEN", "IdToken": "ID_TOKEN", "NewDeviceMetadata": { "DeviceKey": "us-west-2_fec070d2-fa88-424a-8ec8-b26d7198eb23", "DeviceGroupKey": "-wt2ha1Zd" } } }
  • API の詳細については、「 コマンドリファレンスRespondToAuthChallenge」の「」を参照してください。 AWS CLI

次の例は、set-risk-configuration を使用する方法を説明しています。

AWS CLI

リスク設定を行うには

この例では、ユーザープールのリスク設定を設定します。サインアップイベントアクションを NO_ACTION に設定します。

コマンド:

aws cognito-idp set-risk-configuration --user-pool-id us-west-2_aaaaaaaaa --compromised-credentials-risk-configuration EventFilter=SIGN_UP,Actions={EventAction=NO_ACTION}

出力:

{ "RiskConfiguration": { "UserPoolId": "us-west-2_aaaaaaaaa", "CompromisedCredentialsRiskConfiguration": { "EventFilter": [ "SIGN_UP" ], "Actions": { "EventAction": "NO_ACTION" } } } }
  • API の詳細については、「 コマンドリファレンスSetRiskConfiguration」の「」を参照してください。 AWS CLI

次の例は、set-ui-customization を使用する方法を説明しています。

AWS CLI

UI のカスタマイズを設定するには

この例では、ユーザープールの CSS 設定をカスタマイズします。

コマンド:

aws cognito-idp set-ui-customization --user-pool-id us-west-2_aaaaaaaaa --css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n"

出力:

{ "UICustomization": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientId": "ALL", "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n", "CSSVersion": "20190129172214" } }
  • API の詳細については、「 コマンドリファレンスSetUiCustomization」の「」を参照してください。 AWS CLI

次の例は、set-user-mfa-preference を使用する方法を説明しています。

AWS CLI

ユーザー MFA 設定を指定するには

次のset-user-mfa-preference例では、MFA 配信オプションを変更します。MFA 配信メディアを SMS に変更します。

aws cognito-idp set-user-mfa-preference \ --access-token "eyJra12345EXAMPLE" \ --software-token-mfa-settings Enabled=true,PreferredMfa=true \ --sms-mfa-settings Enabled=false,PreferredMfa=false

このコマンドでは何も出力されません。

詳細については、「Amazon Cognito デベロッパーガイド」の「ユーザープールへの MFA の追加」を参照してください。

  • API の詳細については、「 コマンドリファレンスSetUserMfaPreference」の「」を参照してください。 AWS CLI

次の例は、set-user-settings を使用する方法を説明しています。

AWS CLI

ユーザー設定を行うには

この例では、MFA 配信設定を EMAIL に設定します。

コマンド:

aws cognito-idp set-user-settings --access-token ACCESS_TOKEN --mfa-options DeliveryMedium=EMAIL
  • API の詳細については、「 コマンドリファレンスSetUserSettings」の「」を参照してください。 AWS CLI

次の例は、sign-up を使用する方法を説明しています。

AWS CLI

ユーザーをサインアップするには

この例では jane@example.com をサインアップします。

コマンド:

aws cognito-idp sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username jane@example.com --password PASSWORD --user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane"

出力:

{ "UserConfirmed": false, "UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862" }
  • API の詳細については、「 コマンドリファレンスSignUp」の「」を参照してください。 AWS CLI

次の例は、start-user-import-job を使用する方法を説明しています。

AWS CLI

ユーザーインポートジョブを開始するには

この例では、ユーザー入力ジョブを開始します。

ユーザーのインポートの詳細については、「CSV ファイルからユーザープールへのユーザーのインポート」を参照してください。

コマンド:

aws cognito-idp start-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW

出力:

{ "UserImportJob": { "JobName": "import-Test10", "JobId": "import-lmpxSOuIzH", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548278378.928, "StartDate": 1548278397.334, "Status": "Pending", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 } }
  • API の詳細については、「 コマンドリファレンスStartUserImportJob」の「」を参照してください。 AWS CLI

次の例は、stop-user-import-job を使用する方法を説明しています。

AWS CLI

ユーザーインポートジョブを停止するには

この例では、ユーザー入力ジョブを停止します。

ユーザーのインポートの詳細については、「CSV ファイルからユーザープールへのユーザーのインポート」を参照してください。

コマンド:

aws cognito-idp stop-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW

出力:

{ "UserImportJob": { "JobName": "import-Test5", "JobId": "import-Fx0kARISFL", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548278576.259, "StartDate": 1548278623.366, "CompletionDate": 1548278626.741, "Status": "Stopped", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0, "CompletionMessage": "The Import Job was stopped by the developer." } }
  • API の詳細については、「 コマンドリファレンスStopUserImportJob」の「」を参照してください。 AWS CLI

次の例は、update-auth-event-feedback を使用する方法を説明しています。

AWS CLI

認証イベントフィードバックを更新するには

この例では、承認イベントフィードバックを更新します。イベント「Valid」をマークします。

コマンド:

aws cognito-idp update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id EVENT_ID --feedback-token FEEDBACK_TOKEN --feedback-value "Valid"
  • API の詳細については、「 コマンドリファレンスUpdateAuthEventFeedback」の「」を参照してください。 AWS CLI

次の例は、update-device-status を使用する方法を説明しています。

AWS CLI

デバイスのステータスを更新するには

この例では、デバイスのステータスを「not_remembered」に更新します。

コマンド:

aws cognito-idp update-device-status --access-token ACCESS_TOKEN --device-key DEVICE_KEY --device-remembered-status "not_remembered"
  • API の詳細については、「 コマンドリファレンスUpdateDeviceStatus」の「」を参照してください。 AWS CLI

次の例は、update-group を使用する方法を説明しています。

AWS CLI

グループを更新するには

この例では、 の説明と優先順位を更新します MyGroup。

コマンド:

aws cognito-idp update-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup --description "New description" --precedence 2

出力:

{ "Group": { "GroupName": "MyGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New description", "RoleArn": "arn:aws:iam::111111111111:role/MyRole", "Precedence": 2, "LastModifiedDate": 1548800862.812, "CreationDate": 1548097827.125 } }
  • API の詳細については、「 コマンドリファレンスUpdateGroup」の「」を参照してください。 AWS CLI

次の例は、update-resource-server を使用する方法を説明しています。

AWS CLI

リソースサーバーを更新するには

この例では、リソースサーバーの Weather を更新します。これにより、新しいスコープが追加されます。

コマンド:

aws cognito-idp update-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com --name Weather --scopes ScopeName=NewScope,ScopeDescription="New scope description"

出力:

{ "ResourceServer": { "UserPoolId": "us-west-2_aaaaaaaaa", "Identifier": "weather.example.com", "Name": "Happy", "Scopes": [ { "ScopeName": "NewScope", "ScopeDescription": "New scope description" } ] } }
  • API の詳細については、「 コマンドリファレンスUpdateResourceServer」の「」を参照してください。 AWS CLI

次の例は、update-user-attributes を使用する方法を説明しています。

AWS CLI

ユーザー属性を更新するには

この例では、ユーザー属性「nickname」を更新します。

コマンド:

aws cognito-idp update-user-attributes --access-token ACCESS_TOKEN --user-attributes Name="nickname",Value="Dan"
  • API の詳細については、「 コマンドリファレンスUpdateUserAttributes」の「」を参照してください。 AWS CLI

次の例は、update-user-pool-client を使用する方法を説明しています。

AWS CLI

ユーザープールクライアントを更新するには

この例では、ユーザープールクライアントの名前を更新します。また、書き込み可能な属性「nickname」も追加されます。

コマンド:

aws cognito-idp update-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 3n4b5urk1ft4fl3mg5e62d9ado --client-name "NewClientName" --write-attributes "nickname"

出力:

{ "UserPoolClient": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientName": "NewClientName", "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", "LastModifiedDate": 1548802761.334, "CreationDate": 1548178931.258, "RefreshTokenValidity": 30, "WriteAttributes": [ "nickname" ], "AllowedOAuthFlowsUserPoolClient": false } }
  • API の詳細については、「 コマンドリファレンスUpdateUserPoolClient」の「」を参照してください。 AWS CLI

次の例は、update-user-pool を使用する方法を説明しています。

AWS CLI

ユーザープールを更新するには

この例では、ユーザープールにタグを追加します。

コマンド:

aws cognito-idp update-user-pool --user-pool-id us-west-2_aaaaaaaaa --user-pool-tags Team=Blue,Area=West
  • API の詳細については、「 コマンドリファレンスUpdateUserPool」の「」を参照してください。 AWS CLI