RESTクライアント リソース

パラメータ

説明

サーバURL(Server URL)

サーバURLは、APIエンドポイントの定義に使用されるベースパスとしても知られています。サーバURLとパスは、Get、PostなどのHTTP操作に対して呼び出すことができる1つのAPIエンドポイントURLを作成します。

RESTサーバのURLを入力するか、をクリックして環境変数一覧を開きます。ここで、サーバURLとして使用する環境変数を選択することができます。

セキュリティ(Security)

セキュリティタイプは、どのタイプのセキュリティサーバが実装されているかに基づいて使用されます。

これはコンボボックスです。ドロップダウンリストから必要なセキュリティタイプを選択します。

• None (デフォルト)

• HTTP-Basic

• HTTP-Digest

• OAuth2

ユーザ(User)

ユーザがセキュリティで、HTTP-BasicまたはHTTP-Digestを選択したときにRESTクライアントリソースを認証するためのユーザID。

パスワード（Password)

ユーザがセキュリティで、HTTP-BasicまたはHTTP-Digestを選択したときにRESTクライアントリソースを認証するためのパスワード。

OAuthリフレッシュトークンステータス（OAuth Refresh Token Status）

OAuth認証プロセスが実行されたときにリフレッシュトークンが正常に取得されたかどうかを示します。選択できる値は以下のとおりです。

• Missing （デフォルト）

• Available

認証URL(Authorization URL)

認証エンドポイントは、リソースのオーナと対話し、保護されたリソースにアクセスするための承認を取得するために使用されます。

認証URLを入力するか、をクリックして環境変数一覧を開きます。ここで、認証URLとして使用する環境変数を選択することができます。

アクセストークンURL(Access Token URL)

アクセストークンエンドポイントは、アクセストークンまたはリフレッシュトークンを取得するためにアプリケーションによって使用されます。

アクセストークンのURLを入力するか、をクリックして環境変数一覧を開きます。ここで、アクセストークンURLとして使用する環境変数を選択することができます。

コールバックURL(Callback URL)

認証URLを介して認証コードを要求すると、コールバックURLがredirect_uriというパラメータの値として渡されます。認証エンドポイントからの応答が成功すると、このURLにリダイレクトされます。

コールバックURLを入力するか、をクリックして環境変数一覧を開きます。ここで、コールバックURLとして使用する環境変数を選択することができます。

クライアントID(Client Id)

認証を要求するアプリケーションのID。クライアントIDとクライアントシークレットは、認証サーバでのクライアント登録処理時に生成されます。

クライアントIDを入力するか、をクリックして環境変数一覧を開きます。ここで、クライアントIDとして使用する環境変数を選択することができます。

クライアントシークレット(Client Secret)

認証プロセス中にクライアントIDに提供された秘密の文字列。

クライアントシークレットを入力するか、をクリックして環境変数一覧を開きます。ここで、クライアントシークレットとして使用する環境変数を選択することができます。

スコープ(Scope)

スコープが定義されており、OAuthアクセス/リフレッシュトークンを取得している間にスコープが送信されることが期待されている場合は、スコープはオプションになります。

スコープを入力するか、をクリックして環境変数一覧を開きます。ここで、スコープとして使用する環境変数を選択することができます。

State

一部のRESTエンドポイントでは、OAuth2プロセス中にStateパラメーターの指定が必要な場合があります。 このパラメーターは通常、より安全な認証システムである場合に必要です。 パラメータに必要な状態値が不足しているか正しくない場合、OAuth2認証に失敗する可能性があります。 これはクロスサイトリクエストフォージェリ（CSRF）を防ぐために必要です。

(Since version: 4.13)

ボタン

説明

アクセストークン

セキュリティでOAuth2が選択されている場合、このボタンをクリックしてアクセス/リフレッシュトークンを取得します。

ボタンをクリックすると、OAuth認証プロセスが開始されます。このプロセスにより、ユーザはブラウザウィンドウの承認付与ページに移動し、そこでユーザIDとパスワードを使用してログインすることができ、RESTコンポーネントがOAuth承認ウィンドウのリソースにアクセスできるようにするためのアクセス付与が提供されます。このプロセスでは、次のパラメータが使用される認可コードとして認可タイプを使用します。

• Authorization URL

• Access Token URL

• Callback URL

• Client ID

• Client Secret

• Scope(オプション)

ユーザはこれらの値を入力し、プロバイダからアクセストークンを取得するために［トークン作成］ボタンをクリックする必要があります。この操作が完了すると、OAuth Refresh Token Statusパラメータ（上記）はAvailableに設定されます。

パス

RESTクライアントによって使用されるパスを定義します。ユーザは、各パスのクエリパラメータやヘッダパラメータ、フォームパラメータを追加または削除することができます。

このボタンをクリックすると、［パス設定］ウィンドウが開きます。詳細は、こちらをクリックしてください。