API およびマルチステップ API テストでの認証使用

概要

API テストでは、アプリケーションの API エンドポイントにリクエストを送信し、レスポンスタイム、期待されるステータスコード、ヘッダー、本文の内容など、定義された条件とレスポンスを検証することができます。マルチステップ API テストを使用すると、リクエストを連鎖させて、重要なサービス上での複雑なジャーニーを積極的に監視し、それらがいつでも、管理されたロケーションやプライベートロケーションからアクセス可能であることを保証できます。

このガイドでは、Synthetic API およびマルチステップ API テストで利用可能なさまざまな認証プロトコルに ついて説明します。ブラウザテストにおける認証の詳細については、認証が必要なアプリケーションでテストを実行するを参照してください。

認証方法

エンドポイントで認証が必要な場合、API の作成またはマルチステップ API テストの際に資格情報を追加することができます。API およびマルチステップ API テストは、基本アクセス認証、ダイジェストアクセス認証、OAuth2.0、NTLM、AWS Sigv4、クライアント証明書の認証プロトコルをサポートしています。

Define the request セクションで、Advanced Options > Authentication をクリックし、認証方法を選択します。

    HTTP Basic Auth をクリックし、ユーザー名とパスワードを入力します。HTTP テスト、マルチステップ API テスト、WebSocket テストでは、基本アクセス認証がサポートされています。

    Digest Auth をクリックし、ユーザー名とパスワードを入力します。HTTP テストとマルチステップ API テストでは、ダイジェストアクセス認証がサポートされています。

    OAuth 2.0 をクリックし、グラントタイプ (Client Credentials または Resource Password) を選択し、Access Token URL、クライアント ID、およびクライアントシークレットを含めます。トークン API 認証方法 (Send as Basic Auth header または Send client credentials in body) を選択し、オプションでオーディエンス、リソース、およびスコープを含めます。OAuth 2.0 認証は、HTTP テストとマルチステップ API テストでサポートされています。

    NTLM をクリックし、ユーザー名とパスワード、そしてオプションでドメインとワークステーションを入力します。NTLM 認証は、HTTP テストとマルチステップ API テストでサポートされています。

    AWS Signature をクリックし、Access Key ID と Secret Access Key、オプションでリージョン、サービス名、セッショントークンを入力します。AWS Signature 認証は、HTTP テストとマルチステップ API テストでサポートされています。

    秘密鍵ファイルと証明書ファイルをアップロードするには、Upload File をクリックしてください。クライアント証明書は、HTTP テスト、マルチステップ API テスト、SSL テスト、gRPC テストでサポートされています。

    アカウントのセキュリティ

    テスト結果や構成からユーザー資格情報を隠したい場合は、API の作成やマルチステップ API テストの際に、グローバル変数やローカル変数を使用することができます。

    グローバル変数

    資格情報をグローバル変数として保存することで、以下のことが可能になります。

    • 複数のテストに簡単に再利用する。
    • Hide and obfuscate variable value を選択して、テスト結果や構成からその値を隠す。
    • カスタムロールを使用して、組織のユーザーのサブセットにアクセスを制限する。

    ローカル変数

    資格情報をローカル変数として保存することで、資格情報は一意のテストにスコープされます。テスト結果や構成からその値を隠すには、Hide and obfuscate variable value を選択します。

    データセキュリティについては、Synthetic モニタリングのデータセキュリティを参照してください。

    その他の参考資料

    お役に立つドキュメント、リンクや記事:

    Synthetics データセキュリティについてドキュメント more more API テストの作成ドキュメント more more マルチステップ API テストを作成するドキュメント more more