Create JWTAccessToken

JWTAccessToken アクションにより、JSON Web トークン (JWT) が作成されます。

詳しくは、JWT の資料を参照してください。

以下の表では、Create JWTAccessToken アクションのパラメーターを示します。

表 1. Create JWTAccessToken アクションのパラメーター
名前	データ・タイプ	関係	必須	注
Header	KeyValuePairs	サブエレメント	はい	JWT ヘッダーを形成する名前/値のペアのセット。詳しくは、表 2 を参照してください。
Payload	KeyValuePairs	サブエレメント	はい	JWT ペイロードを形成する名前/値のペアのセット。詳しくは、表 3 を参照してください。
Secret	ストリング	サブエレメント	はい	V1 では、秘密鍵が Base64 PKCS8 PEM ファイルでなければなりません。 V2 以降では、PVKS1 または PVKS8 のいずれかの PEM ファイルを使用でき、プレーン・テキストまたは Base64 エンコードとして入力できます。詳しくは、表 4 を参照してください。
savePath	JPath	属性	はい	この値を保管する、状態内の場所。

表 2. Header の構造
名前	データ・タイプ	説明	必須	注
名前	ストリング	ヘッダーの名前。	はい
値	ストリング	ヘッダーの値。	いいえ

表 3. Payload の構造
名前	データ・タイプ	説明	必須	注
名前	ストリング	ペイロードの名前。	はい
値	ストリング	ペイロードの値。	いいえ

表 4. Secret の構造
名前	データ・タイプ	説明	必須	注
値	ストリング	秘密の値。	いいえ

XML の例

このアクションにより、指定されたヘッダー、ペイロード、および秘密の値を使用して JWT が作成され、状態内の場所 /access_token に保存されます。

<CreateJWTAccessToken savePath="/access_token">
    <Header>
        <Value name="alg" value="HS256" />
        <Value name="typ" value="JWT" />
    </Header>
    <Payload>
        <Value name="iss" value="${/api_key}" />
    </Payload>
    <Secret value="${/api_secret}" />
</CreateJWTAccessToken>