共通認証

APIリクエストで情報の送受信に認証が必要な場合、認証タイプに固有の認証情報を構成できます。Blue Prismは、APIリクエストに対して次の認証タイプの使用をサポートします。

認証情報は、Web APIに認証されたリクエストを送信するのに必要なデータ格納用に使用されます。上の認証タイプに適用可能な認証情報は、認証情報マネージャーで作成され、Web APIへのリクエストを認証するために使用されます。API定義で選択した認証情報は、関連するすべてのアクションに使用されます。ただし、プロセスに公開されている場合は、代替認証情報は指定されていれば、入力パラメーターとして使用できます。

以下の例では、オブジェクトスタジオおよびプロセススタジオのアクション入力で代替値が指定されていない場合に、すべての関連アクションのデフォルトの認証情報としてAPI定義で［アドレス認証情報］が選択されています。

［プロセスに公開］が選択されていることを考慮すると、関連する入力パラメーターをプロセスに利用できます。代替認証情報の名前が入力パラメーターで指定されており、APIが呼び出されるときに使用されます。

認証タイプ

次の認証タイプをWeb API定義内で構成できます。

なし

APIは認証を必要としません。

基本

HTTP基本認証を使用して、リクエストヘッダー内の選択した認証情報からユーザー名とパスワードを送信します。必要な場合やAPIがサポートしている場合は、［事前に認証ヘッダーを送信］チェックボックスを選択します。事前の認証では、認証されていない応答に応答する場合とは違い、基本認証応答をHTTPリクエストとともに直接送信します。

ドロップダウンリストから必要な認証情報を選択し、必要に応じて［プロセスに公開］を選択してパラメーター名を入力します。

OAuth 2.0（クライアント認証情報）

クライアントIDとシークレットを使用して認証サーバーにリクエストを送信します。認証情報が有効な場合は、APIリクエストの認証に使用されるアクセストークンが返されます。

認証タイプは次のフィールドを使用して構成します。

  • 承認URI - 認証サーバーのアドレス。
  • 認証情報 - 認証サーバーからアクセストークンを取得するために使用されるクライアントIDとクライアントシークレットを含む、認証情報マネージャー内の認証情報の名前。
  • パラメーター名 - 認証がオブジェクトおよびプロセスに公開されている場合は、アクションの入力パラメーターの名前。
  • 範囲 - トークンによって許可される、認証サーバーからリクエストされたアクセスのレベル。

OAuth 2.0（JWTベアラートークン）

この認証情報タイプは、認証するためにJSON Webトークン（JWT）を使用するOAuth 2.0認証の形式であり、標準のOAuth 2.0と同様にクライアントIDとシークレットを提供します。情報のリクエスト元や、その使用目的を指定するリクエストデータは、署名付きJWTとして認証サーバーに送信されます。JWTが有効な場合、サーバーはAPIリクエストの認証に使用するアクセストークンを返します。

次のフィールドはリクエストの作成に使用されます。

  • アルゴリズム - JWTへの署名に使用されるアルゴリズム - 現在はRSA SHA-256アルゴリズムタイプのみがサポートされています。
  • 承認URI - 認証サーバーのアドレス。
  • 対象者 - 認証サーバーをトークンの意図した受信者として識別するために使用されます。
  • 範囲 - トークンによって許可される、認証サーバーからリクエストされたアクセスのレベル。
  • 件名 - 件名は通常、アクセストークンがリクエストされているユーザーを識別します。このフィールドではパラメーターを使用できます。
  • JWTの有効期限 - トークンが認証サーバーによって受け入れられなくなるまでの時間。
  • 認証情報 - 認証情報マネージャーで構成された、リクエストの認証に使用する認証情報。
  • パラメーター名 - 認証がオブジェクトおよびプロセスに公開されている場合は、アクションの入力パラメーターの名前。

ベアラートークン

この認証情報タイプは、トークンがすでに取得済みで、認証ヘッダーで送信する必要がある状況に対応します。これは、Blue Prismがトークンを取得するためにコードステージなどの別のメソッドを使用するような状況をサポートするために使用できます。

トークンは認証情報に格納され、API定義で参照されます。リクエストヘッダーで使用される場合、トークンは次の形式で渡されます。

認証：ベアラー<アクセストークン>

たとえば、認証：ベアラーFGRS5-PUUDW-NBC2Q-96UYR-QBDSY

カスタム

カスタム認証情報を使用すると、Blue Prismで独自の認証メソッドを使用できます。たとえば、認証情報のパスワードフィールドにセキュアに格納されているAPIキーまたはサブスクリプションキーを使う認証にカスタム認証情報を使用できます。認証情報マネージャーに格納されている認証情報は、リクエスト本文、ヘッダー、またはURLで使用できるよう、パラメーターとしてAPIリクエストに渡すことができます。

カスタム認証情報の使用に関する詳細については、「カスタム認証情報」を参照してください。