Security Schemeの使用

フォルダレベルでのSecurity Scheme設定

1

任意のフォルダを選択し、右側のAuthタブをクリックして、認証タイプとしてSecurity Schemeを選択。

2

ドロップダウンメニューから希望のSecurity Schemeを選択。

3

Security SchemeとしてOAuth 2.0を選択した場合、必要なScopesをさらに選択可能。

フォルダレベルで設定されたSecurity Schemeは、そのフォルダ内のすべてのサブフォルダとAPIに適用されます。ただし、それらが独自の認証設定を持っている場合は除きます。

APIレベルでのSecurity Scheme設定

1

任意のAPIを選択し、右側の変更タブに移動。Requestセクションで、認証タイプとしてSecurity Schemeを選択。

2

ドロップダウンメニューから希望のSecurity Schemeを選択。

3

Security SchemeとしてOAuth 2.0を選択した場合、必要なScopesをさらに選択可能。

APIレベルで設定された認証設定は、フォルダレベルの設定を上書きします。

Security Schemeのデフォルト値設定

Security Schemeは認証方法のみを定義します。APIをデバッグする際には、実際の認証値を提供する必要があります。

APIデバッグ中に認証値を繰り返し入力する手間を省くために、Apidogではデフォルトの認証値を設定できます。一度設定すると、手動で上書きしない限り、デバッグ中に自動的に使用されます。フォルダにデフォルトの認証値が設定されている場合、そのフォルダ内のすべてのAPIで使用できます。

1

リストからSecurity Schemeを選択し、デフォルト認証値を設定。

2

認証タイプに基づいて値を入力：

API Key：キーを入力

Basic Auth：ユーザー名とパスワードを入力

Bearer Token：トークンを入力

OAuth 2.0：Client ID、Client Secretなどを入力

その他の方法：対応する値を入力

認証値の継承とカスタマイズ

Security Schemeを使用する際、以下のいずれかを選択できます：

1.

親フォルダから継承：親またはルートフォルダで定義されたSecurity Schemeとデフォルト値を使用。

2.

認証値をカスタマイズ：同じSecurity Schemeを維持しつつ、デフォルト値を上書き。

複数のSecurity Scheme使用

Apidogは、単一のAPIに対して複数のSecurity Schemeを設定することをサポートしており、OpenAPI仕様で定義された複数の認証タイプのメカニズムに対応しています：

AND：ANDで結合されたSecurity Schemeは、同じリクエストで同時に使用する必要があります（近日公開予定）。

OR：ORで結合されたSecurity Schemeは代替手段であり、任意の1つを使用できます。

Auth設定の+ボタンを使用して、さらにSecurity Schemeを追加します。

OAuth 2.0 Security SchemeのScopes選択

OpenAPI仕様に従い、OAuth 2.0 Security Schemeを作成する際には、すべての可能なScopesを定義する必要があります。APIで使用する際には、必要なScopesを選択する必要があります。

これを簡単にするために、ApidogではフォルダレベルでデフォルトのScopesを設定できます。これらのデフォルトは、APIレベルで異なるScopesを手動で設定しない限り、フォルダ内のすべてのAPIに適用されます。

1

APIのAuth設定でOAuth 2.0を選択。

2

Scopesセクションで、Security Schemeによって定義されたすべての利用可能なScopesを表示し、必要なものを選択。

3

APIが親フォルダからScopesを継承している場合、Reset the scopes to the configuration of the parent folderをクリックして親の設定に戻すことができます。

OAuth 2.0 Security Schemeを使用したAPIのデバッグ

OAuth 2.0 Security Schemeのデフォルト値としてトークンを事前に設定することで、APIをデバッグするたびに新しいトークンを取得する必要がなくなります。

フォルダレベルでトークンをデフォルトの認証値として取得

1

フォルダを選択し、Authタブに移動して、OAuth 2.0 Security Schemeを選択し、Scopesと認可タイプを選択して、Get Tokenをクリック。

2

ポップアップパネルで：

ClientID、Client Secretなどを入力

テストをクリック

3

トークンを取得した後、その詳細を表示できます。これには、有効期限が含まれます。このトークンはフォルダ内のすべてのAPIで使用できます。

APIレベルでトークンをデフォルトの認証値として取得

1

希望するAPIを選択し、変更に移動して、OAuth 2.0 Security Schemeを選択し、Get Tokenをクリック。

2

ポップアップパネルで：

Client ID、Client Secretなどを入力

Continueをクリック

test-oauth-2-0-token-security-scheme-endpoint-level.png

3

認証を完了してトークンを取得

このトークンはこのAPIのデバッグに使用されます

APIデバッグ用のデフォルトトークンの使用または新しいトークンの生成

ApidogでAPIをデバッグする際、認証トークンを適用するための2つのオプションがあります：

方法1: デフォルトの認証トークンを使用

APIを実行する際、実行パネルのAuthタブに移動し、Use Parent Default Auth Valuesを選択します。親フォルダで設定されたデフォルトの認証トークンが自動的にAPIリクエストに適用されます。

use a default auth token for endpoint debugging.png

方法2: 新しいトークンを生成

1

APIを実行する際、実行パネルのAuthタブに移動し、Set Manuallyを選択します。Get Tokenをクリックしてトークン生成パネルを開きます。

generate a new token for endpoint debugging.png

2

ポップアップパネルで：

Client ID、Client Secretなどを入力

Continueをクリック

fill information for generating new token.png

3

認証を完了してトークンを取得

このトークンは現在のAPIのデバッグに使用されます

Modified at 2025-04-27 10:17:30

Security Schemeの作成

オンラインドキュメントにおけるSecurity Scheme