API GatewayのCognito UserPools AuthorizerでCognitoのcustom attributesを取得する

API GatewayでCognitoのカスタム属性(custom attributes)を使用したくなる場合があります。

⬆ここにカスタム属性を含められればそのままLambdaへ渡せるので便利。

Cognito UserPools Authorizerを使用する方法自体は以下が参考になります。

• API GatewayでCognito UserPools Authorizerを使う

今回はここにCognitoのカスタム属性を含める方法を記載します。

手順

カスタム属性を作成する

• Cognito > ユーザープール > 属性 > カスタム属性の追加

カスタム属性に値を格納

AWS CLI を使用してcustom:my-address というカスタム属性に値を格納する例。

aws cognito-idp admin-update-user-attributes \
  --user-pool-id ap-northeast-1_XXXXXXXX \
  --username foobar \
  --user-attributes "[{\"Name\":\"custom:my-address\",\"Value\":\"0x9A84E702e8D82Ac4522d4E0790C141696d89d324\"}]" \

アプリクライアントの属性への読み取り権限を付与する

• Cognito > アプリクライアント > 詳細を表示 > 属性の読み込みおよび書き込みアクセス権限を設定する

対象のクライアントでアクセストークンを生成

• 詳細割愛

オーサライザーで確認

• トークンは取得し直さなければ反映されない場合あり

以上。