セキュリティスキームを使用する

フォルダレベルでセキュリティスキームを設定する

1

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

セキュリティスキーム認証タイプの選択

2

ドロップダウンメニューから目的の Security Scheme を選択します。

目的のセキュリティスキームの選択

3

セキュリティスキームとして OAuth 2.0 を選択した場合は、必要な Scopes をさらに選択できます。

セキュリティスキームスコープの選択

フォルダレベルで設定されたセキュリティスキームは、独自の認証設定がない限り、そのフォルダ配下のすべてのサブフォルダおよびエンドポイントに適用されます。

エンドポイントレベルでセキュリティスキームを設定する

1

任意のエンドポイントを選択し、右側の Edit タブに移動します。Request セクションで、認可タイプとして Security Scheme を選択します。

エンドポイントレベルでのセキュリティスキームの設定

2

ドロップダウンメニューから目的の Security Scheme を選択します。

エンドポイント用の目的のセキュリティスキームの選択

3

セキュリティスキームとして OAuth 2.0 を選択した場合は、必要な Scopes をさらに選択できます。

エンドポイントのセキュリティスキームスコープの選択

エンドポイントレベルで設定された Auth 設定は、フォルダレベルの設定を上書きします。

セキュリティスキームのデフォルト値を設定する

セキュリティスキームは認証方法のみを定義します。エンドポイントをデバッグする際には、実際の認証値を指定する必要があります。

エンドポイントのデバッグ中に認証値を繰り返し入力する手間を避けるため、Apidog ではデフォルトの認証値を設定できます。設定後は、手動で上書きしない限り、デバッグ時にこれらのデフォルト値が自動的に使用されます。フォルダにデフォルトの認証値が設定されている場合、その配下のすべてのエンドポイントで使用できます。

1

リストからセキュリティスキームを選択し、Default Auth Values を設定します。

デフォルト認証値

2

認証タイプに基づいて値を入力します。

API Key: キーを入力します

Basic Auth: ユーザー名とパスワードを入力します

Bearer Token: トークンを入力します

OAuth 2.0: クライアント ID、クライアントシークレットなどを入力します

Other methods: 対応する値を入力します

認証値を継承およびカスタマイズする

セキュリティスキームを使用する場合、次のいずれかを選択できます。

1. 親フォルダから継承する

親フォルダまたはルートフォルダで定義されたセキュリティスキームとデフォルト値を使用します。

セキュリティスキームの継承

2. 認証値をカスタマイズする

同じセキュリティスキームを維持しつつ、そのデフォルト値を上書きします。

セキュリティスキームのカスタマイズ

複数のセキュリティスキームを使用する

Apidog は、単一のエンドポイントに対して複数のセキュリティスキームを設定することをサポートしています。これは、OpenAPI 仕様で定義されている複数の認証タイプの仕組みに準拠しています。

AND: AND で組み合わせられたセキュリティスキームは、同じリクエスト内で同時に使用する必要があります（近日提供予定）。

OR: OR で組み合わせられたセキュリティスキームは代替手段であり、指定されたコンテキストではいずれか 1 つを使用できます。

Auth 設定の + ボタンを使用して、さらにセキュリティスキームを追加します。

複数のセキュリティスキームの追加

OAuth 2.0 セキュリティスキームのスコープを選択する

OpenAPI 仕様によると、OAuth 2.0 セキュリティスキームを作成する際には、利用可能なすべての Scopes を定義する必要があります。エンドポイントで使用する際には、必要なスコープを選択する必要があります。

作業を簡単にするため、Apidog ではフォルダレベルでデフォルトのスコープを設定できます。エンドポイントレベルで異なるスコープを手動で設定しない限り、これらのデフォルトはフォルダ内のすべてのエンドポイントに適用されます。

1

エンドポイントの Auth 設定で、OAuth 2.0 を選択します。

2

Scopes セクションで、セキュリティスキームによって定義された利用可能なすべてのスコープを確認し、必要なものを選択できます。

エンドポイントレベルでの認証スコープの選択

3

エンドポイントが親フォルダからスコープを継承している場合、Reset the scopes to the configuration of the parent folder をクリックして親フォルダの設定に戻すことができます。

スコープ設定のリセット

OAuth 2.0 セキュリティスキームでエンドポイントをデバッグする

OAuth 2.0 セキュリティスキームのデフォルト値としてトークンを事前設定できるため、API をデバッグするたびに新しいトークンを取得する必要がありません。

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

1

フォルダを選択し、Auth タブに移動して、OAuth 2.0 セキュリティスキームを選択し、スコープとグラントタイプを選択してから、Get Token をクリックします。

フォルダレベルで OAuth 2.0 トークンを取得

2

ポップアップパネルで、次の操作を行います。

クライアント ID、クライアントシークレットなどを入力します。

Continue をクリックします

OAuth 2.0 トークンセキュリティスキームのテスト

3

トークンを取得した後、有効期限を含む詳細を確認できます。このトークンは、フォルダ内のすべてのエンドポイントで使用できます。

フォルダ内のトークン詳細の表示

エンドポイントレベルでデフォルト認証値としてトークンを取得する

1

目的のエンドポイントを選択し、Edit に移動して、OAuth 2.0 セキュリティスキームを選択し、Get Token をクリックします。

エンドポイントレベルでトークンを取得

2

ポップアップパネルで、次の操作を行います。

クライアント ID、クライアントシークレットなどを入力します。

Continue をクリックします

エンドポイントレベルで OAuth 2.0 トークンセキュリティスキームをテスト

3

認可を完了してトークンを取得します

トークンはこのエンドポイントのデバッグに使用されます

トークン詳細の表示

エンドポイントのデバッグにデフォルトトークンを使用する、または新しいトークンを生成する

Apidog でエンドポイントをデバッグする際、認証トークンを適用するには 2 つのオプションがあります。

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

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

エンドポイントデバッグにデフォルト認証トークンを使用

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

1

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

エンドポイントデバッグ用の新しいトークンを生成

2

ポップアップパネルで、次の操作を行います。

クライアント ID、クライアントシークレットなどを入力します。

Continue をクリックします

新しいトークン生成用情報の入力

3

認可を完了してトークンを取得します

トークンは現在のエンドポイントのデバッグに使用されます

Modified at 2026-06-11 07:06:02

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

オンラインドキュメントにおけるセキュリティスキーム