メイン コンテンツをスキップする 補完的コンテンツへスキップ

APIセキュリティをデザイン

APIデザインプロセスの一環として、API(認証)にアクセスできるコンシューマーと、許可されるオペレーション(承認)を指定する必要があります。

情報メモ注: Talend Cloud API Designerによってデザインおよびドキュメンテーションの目的でセキュリティパラメーターを定義できるようになりますが、Talend StudioでAPI定義を使う時にセキュリティが自動的に実装されていません。

API全体に共通のセキュリティを定義するか、重要なリソースに対して特定のセキュリティを使用して詳細なポリシーを選択できます。

また、認証なしで特定のオペレーションを自由にアクセスできるように指定することもできます。

Talend Cloud API Designerでは、以下の主なセキュリティタイプですべてのケースを扱えます:
  • 基本認証
  • ベアラー認証
  • ダイジェスト認証
  • OAuth1.0
  • OAuth2.0
  • OpenID Connect
  • カスタム/APIキー
  • パススルー

Cookie認証はサポートされていません。

セキュリティスキームを作成

APIバージョンで、または個々のエレメントでグローバルに使用されるセキュリティスキームを作成します。

手順

  1. APIの一般情報ページに移動します。
  2. [SECURITY SCHEMES] (セキュリティスキーム) セクションまでスクロールし、[Add] (追加) をクリックして新しいスキームを作成します。
  3. ドロップダウンリストで[Type] (タイプ) を選択し、[Name] (名前)を入力します。
  4. オプション: [Description] (説明)を入力します。
  5. 選択したタイプに固有のその他のパラメーターを入力します。

    セキュリティスキームの定義例。
  6. [Save] (保存)をクリックします。

タスクの結果

これで、セキュリティスキームが作成され、APIのグローバル設定または特定のリソースと操作で使用できるようになります。

APIセキュリティを定義

API、リソース、オペレーションのセキュリティスキームを定義します。

手順

  1. APIの名前をクリックすると、一般情報に移動します。
  2. セキュリティスキームを追加し、APIバージョンに対してグローバルに適用するものを選択します。
    この例では、Petstore APIはpetstore_authによってwrite:petsというスコープで保護されています。
  3. [Save] (保存)をクリックします。
  4. リソースを選択し、リソースのすべてのオペレーションに適用するセキュリティスキームを選択します。
    または、特定のセキュリティを定義するオペレーションを選択することもできます。
    この例では、Find Pets by tagsメソッドはpetstore_authを使って保護されています。
  5. [Save] (保存)をクリックします。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。