認証コード付与タイプを使用した OAuth 2.0 サーバーの構成
認証コード付与タイプは、認証サーバーからアクセス トークンと更新トークンを取得するために使用するもので、機密クライアント用に最適化されています。
Kofax TotalAgility は、更新トークンの付与による認証コード付与のみをサポートします。これは、設計時にアクセス トークンと更新トークンを生成する必要があることを意味します。TotalAgility は、更新トークンを使用してアクセス トークンを再生成するため、手動での操作は必要ありません。
-
に移動します。
[OAuth 2.0 サーバー] ページが表示されます。
-
[新規] をクリックします。
[新しい OAuth 2.0 サーバー構成] ダイアログ ボックスが表示されます。デフォルトでは、[全般] タブが開いています。
-
以下のプロパティを構成します。
一般プロパティ
[名前] OAuth 2.0 サーバーのグローバルな一意の名前。
名前には最大 50 文字を使用できます。
[カテゴリ] デフォルトでは、システムによって新しい OAuth サーバーが作業カテゴリに自動的に保存されます。別のカテゴリに保存するには、カテゴリを選択します。
[付与タイプ] 認証コード。
[認証方法] 認証方法を指定して、認証付与にセキュリティを追加します。次の方法を使用できます。
認証方法に固有のフィールドの説明については、「認証方法」を参照してください。
[クライアント ID] クライアントを識別するための ID。ID は英数字の文字列である必要があります。
[クライアント シークレット] クライアントが使用するシークレット文字列。
[アクセス トークン URL] アクセス トークンを取得するための URL。
[範囲] 指定した領域へのアクセスを制限する範囲。
範囲の値は、スペースで区切り、大文字と小文字を区別した文字列のリストとして定義する必要があります。[認証コード URL] 認証サーバーから認証コードを取得するための URL。
[リダイレクト URI] 認証サーバーがこのプリセットの TotalAgility URI にリダイレクトするように構成されている場合、認証コードが自動的に抽出され、トークン生成プロセスに使用されます。
このオプションをオフにした場合、読み取り専用モードの [リダイレクト URI] フィールドにはプリセットの URL が表示され、認証コードが自動的に抽出されます。
[カスタム リダイレクト URI を使用する] このオプションを選択して、認証サーバーを構成するカスタム リダイレクト URI を指定します。
認証サーバーがこの URI にリダイレクトする場合は、URI から認証コード全体をコピーして、[認証コード URL] フィールドに貼り付けます。
[状態を使用する] このオプションを選択した場合、認証の受信中に検証されるランダムな文字列がアプリケーションで生成されます。(デフォルト: 選択済み)
[PKCE を使用する] 認証サーバーが PKCE (Proof Key for Code Exchange) をサポートしている場合は、このオプションを選択して、認証コードの傍受やその他の攻撃を防ぎます。
[更新トークンをサポート] このオプションを選択した場合、認証サーバーは更新トークンの生成をサポートします。
このオプションは読み取り専用で、認証コードの付与に対して常に選択済みになっています。(デフォルト: 選択済み)
[トークンの有効期間を更新] トークンが有効である期間。ゼロに設定した場合、更新トークンは常に有効なままになります。(デフォルト: 0)
追加のプロパティ
[アクセス トークン リクエスト] アクセス トークン リクエストを送信するときに、次のパラメータを除外したり、含めたりできます。
-
[範囲を含める] (デフォルト: 選択済み)
-
[リダイレクト URI を含める] (デフォルト: 選択済み)
[最大再試行回数] アクセス トークンの取得を再試行する最大回数。(デフォルト: 3)
[最大待機時間] アクセス トークンを取得するための最大待機時間。(デフォルト: 1 分)
[クエリ パラメータ] 認証サーバーに必要なクエリ パラメータ (存在する場合)。クエリ パラメータを追加するには、以下の手順を実行します。
-
をクリックします。
-
[名前] と [値] を入力します。
-
[追加] をクリックします。
[ポスト パラメータ] 認証サーバーに必要なポスト パラメータ (存在する場合)。ポスト パラメータを追加するには、以下の手順を実行します。
-
をクリックします。
-
[名前] と [値] を入力します。
-
[追加] をクリックします。
-
-
[承認する] をクリックします。
新しいブラウザに認証サーバーのログイン ページが表示され、URI の構成に応じて次のいずれかが発生します。
-
認証サーバーがプリセットの Kofax TotalAgility リダイレクト URI にリダイレクトするように構成されている場合、認証コードが自動的に抽出され、トークン生成プロセスに使用されます。
-
認証サーバーがカスタム URI にリダイレクトするように構成されている場合は、ブラウザのアドレス バーから URL 全体をコピーして、[認証コード URL] フィールドに貼り付ける必要があります。
認証が完了し、TotalAgility Designer が認証コードを抽出するまで、認証ボタンは無効になります。 -
-
[保存] をクリックして、アクセス トークンと更新トークンを取得します。
認証サーバーは、アクセス トークンと更新トークンの認証コードの交換を行います。
-
トークンの生成に失敗すると、エラー メッセージが表示されます。ただし、構成の詳細は再利用のために保存されます。
-
すでに認証済みの認証コード付与タイプを使用して OAuth 2.0 サーバーを編集する場合は、再度認証する必要があります。
-