CognitoユーザープールのIDトークンのクレームに新しい値を追加してみる

CognitoではいろいろなフェーズでLambda関数をトリガーして実行することが可能です。CognitoのIDトークンのクレームをカスタマイズするためのトークン生成前Lambdaトリガーを利用して、CognitoのIDトークンに新しい値を追加してみます。

#Amazon Cognito

#AWS

Kitano Yuichi

2020.07.29

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

CognitoユーザープールはいろいろなフェーズでLambda関数をトリガーして実行することが可能です。

参考：Lambda トリガーを使用したユーザープールワークフローのカスタマイズ - Amazon Cognito

Cognitoの IDトークン のクレームをカスタマイズできるように、 トークン生成前Lambdaトリガー という機能が用意されています。

参考：トークン生成前 Lambda トリガー - Amazon Cognito

これを利用して、Cognitoの IDトークン に新しい値を追加してみます。

前提条件

Cognitoでログインした後、 IDトークン を確認できるような環境はすでに構築済みであることを前提とします。

先日書いたこのブログの環境を流用します。

現在のIDトークンを確認する

まずは通常のIDトークンを確認してみます。

ローカルでCognitoログインできる環境を動かして、ページにアクセスします。

Cognitoのログイン画面でEmail/パスワードを入力してログインします。

そうすると、こんな感じでIDトークンに入っているユーザー情報が表示されます。

Cognitoの IDトークン 含む各種トークンについては、以前ブログを書きましたので詳細はこちらをご参照ください。

Cognitoトリガー用のLambdaを作成する

IDトークンに新しい値を追加するためのLambdaを適当な名前で作成します。今回は CognitoPreTokenGeneration という名前にしています。ランタイムは Node.js 12.x としています。

公式ドキュメントを参照すると、トークン生成前のLambdaトリガーで response 内の claimsToAddOrOverride にクレームのキーと値を設定することで、IDトークンにクレームを追加できるようです。

参考：トークン生成前 Lambda トリガー - Amazon Cognito

よって、Lambdaに次のコードを保存してIDトークンのクレームに固定値を追加するようにしてみます。

exports.handler = async (event) => {
    console.log(event);

    event.response = {
        "claimsOverrideDetails": {
            "claimsToAddOrOverride": {
                "my-attribute-key": "my-attribute-value"
            },
        }
    };

    // Return to Amazon Cognito
    return event;
};