プロパティ | 説明 |
---|---|
接続名 | 接続の名前。 各接続名は組織内で一意である必要があります。接続名には、英数字、スペース、および次の特殊文字を含めることができます。_ .+ -, 最大長は255文字です。 |
説明 | 接続の説明。最大長は4000文字です。 |
タイプ | REST V2 |
ランタイム環境 | タスクを実行するランタイム環境の名前。 Secure Agent、ホステッドエージェント、またはサーバーレスランタイム環境を選択します。 |
プロパティ | 説明 |
---|---|
認証タイプ | 標準認証を選択した場合に使用できる認証タイプ。 以下のいずれかの認証タイプを選択できます。
デフォルトはNONEです。 |
認証ユーザーID | 標準認証を選択した場合にWebサービスアプリケーションにログインするためのユーザー名。 基本認証タイプの場合は必須です。 |
認証パスワード | 標準認証を選択したときにユーザー名に関連付けたパスワード。 基本認証タイプの場合は必須です。 |
OAuthコンシューマキー | Webサービスアプリケーションに関連付けられるクライアントキー。 認証タイプが[OAuth]の場合にのみ必要です。 |
OAuthコンシューマシークレット | Webサービスアプリケーションに接続するためのクライアントパスワード。 認証タイプが[OAuth]の場合にのみ必要です。 |
OAuthトークン | Webサービスアプリケーションに接続するためのアクセストークン。 認証タイプが[OAuth]の場合にのみ必要です。 |
OAuthトークンシークレット | OAuthトークンに関連付けられるパスワード。 認証タイプが[OAuth]の場合にのみ必要です。 |
Swaggerファイルパス | SwaggerファイルまたはOpenAPIファイルのパス。 次のいずれかのファイルパスを指定できます。
例えば、Swaggerファイルのパスは次のようになります。 C:\swagger\sampleSwagger.json ユーザーにはフォルダとファイルの読み取り権限が必要です。 |
プロパティ | 説明 |
---|---|
アクセストークンURL | アプリケーションで設定されているアクセストークンURL。 |
クライアントID | アプリケーションのクライアントID。 |
クライアントシークレット | アプリケーションのクライアントシークレット。 |
スコープ | APIエンドポイントでカスタムスコープが定義されている場合に、アクセス制御を指定します。スコープ属性をスペースで区切って入力します。例: root_readonly root_readwrite manage_app_users |
アクセストークンパラメータ | アクセストークンURLで使用する追加パラメータ。パラメータはJSON形式で定義します。 例: [{"Name":"resource","Value":"https://<serverName>"}] |
クライアント認証 | 認証のために要求本文または要求ヘッダーのいずれかでクライアントIDとクライアントシークレットを送信するオプションを選択します。 デフォルトは、[本文でクライアント資格情報を送信する]です。 |
アクセストークンの生成 | 上のフィールドで指定した情報に基づいて、アクセストークンを生成します。 |
アクセストークン | アクセストークンの値。 アクセストークンの値を入力するか、[アクセストークンの生成]をクリックして、アクセストークンの値を指定します。 プロキシサーバーを介してアクセストークンの生成呼び出しを渡すには、Secure Agentプロパティで認証されていないプロキシサーバーを設定する必要があります。接続設定で設定されたプロキシは、アクセストークンの生成呼び出しには適用されません。 |
Swaggerファイルパス | SwaggerファイルまたはOpenAPIファイルのパス。 次のいずれかのファイルパスを指定できます。
例えば、Swaggerファイルのパスは次のようになります。 C:\swagger\sampleSwagger.json ユーザーにはフォルダとファイルの読み取り権限が必要です。 |
プロパティ | 説明 |
---|---|
認証トークンURL | アプリケーションで設定されている認証サーバーURL。 |
アクセストークンURL | アプリケーションで設定されているアクセストークンURL。 |
クライアントID | アプリケーションのクライアントID。 |
クライアントシークレット | アプリケーションのクライアントシークレット。 |
スコープ | APIエンドポイントでカスタムスコープが定義されている場合に、アクセス制御を指定します。スコープ属性をスペースで区切って入力します。 例: root_readonly root_readwrite manage_app_users |
アクセストークンパラメータ | アクセストークンURLで使用する追加パラメータ。パラメータはJSON形式で定義します。 例: [{"Name":"resource","Value":"https://<serverName>"}] |
認証コードパラメータ | 認証トークンURLで使用する追加パラメータ。パラメータはJSON形式で定義します。 例: [{"Name":"max_age","Value":60},{"Name":"state","Value":"test"}] |
クライアント認証 | 認証のために要求本文または要求ヘッダーのいずれかでクライアントIDとクライアントシークレットを送信するオプションを選択します。 デフォルトは、[本文でクライアント資格情報を送信する]です。 |
アクセストークンの生成 | 上のフィールドで指定した情報に基づいて、アクセストークンを生成し、トークンをリフレッシュします。 |
アクセストークン | アクセストークンの値。 アクセストークンの値を入力するか、[アクセストークンの生成]をクリックして、アクセストークンの値を指定します。 プロキシサーバーを介してアクセストークンの生成呼び出しを渡すには、Secure Agentプロパティで認証されていないプロキシサーバーを設定する必要があります。接続設定で設定されたプロキシは、アクセストークンの生成呼び出しには適用されません。 |
更新トークン | 更新トークンの値。 リフレッシュトークンの値を入力するか、[アクセストークンの生成]をクリックして、リフレッシュトークンの値を指定します。アクセストークンが有効でないか、有効期限切れの場合、Secure Agentは、リフレッシュトークンを使用して新しいアクセストークンを取得します。 リフレッシュトークンが期限切れの場合は、有効なリフレッシュトークンを指定するか、[アクセストークンの生成]をクリックして新しいリフレッシュトークンを生成します。 |
Swaggerファイルパス | SwaggerファイルまたはOpenAPIファイルのパス。 次のいずれかのファイルパスを指定できます。
例えば、Swaggerファイルのパスは次のようになります。 C:\swagger\sampleSwagger.json ユーザーにはフォルダとファイルの読み取り権限が必要です。 |
プロパティ | 説明 |
---|---|
JWTヘッダー | JSON形式のJWTヘッダー。 サンプル: { "alg":"RS256", "kid":"xxyyzz" } HS256およびRS256アルゴリズムを設定できます。 |
JWTペイロード | JSON形式のJWTペイロード。 サンプル: { "iss":"abc", "sub":"678", "aud":"https://api.box.com/oauth2/token", "box_sub_type":"enterprise", "exp":"120", "jti":"3ee9364e" } expとして表される有効期限は、秒単位の相対時間です。有効期限は、トークン発行者の時間(iat)からUTC形式で計算されます。 ペイロードにiatが定義されており、有効期限に達すると、マッピングとアクセストークンの生成が失敗します。新しいアクセストークンを生成するには、ペイロードに有効なiatを指定する必要があります。 iatがペイロードで定義されていない場合、有効期限は現在のタイムスタンプから計算されます。 有効期限を文字列値として渡すには、値を二重引用符で囲みます。例: "exp":"120" 有効期限を整数値として渡すには、値を二重引用符で囲まないでください。 例: "exp":"120" |
認証サーバー | アプリケーションで設定されているアクセストークンURL。 |
キーストアファイルパス | REST APIとの双方向の安全な接続を確立するために必要なキーと証明書を含むキーストアファイルの絶対パス。各Secure Agentマシンで使用可能なディレクトリパスを指定します。 また、キーストアファイル名とパスをJVMオプションとして設定するか、証明書を任意のディレクトリにインポートすることもできます。 サーバーレスランタイム環境の場合、サーバーレスエージェントディレクトリでキーストアファイルパスを指定します。 例: /home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks |
キーストアのパスワード | 通信を安全に行うために必要なキーストアファイルのパスワード。 キーストアのパスワードをJVMオプションとして設定することもできます。 |
プライベートキーのエイリアス | JWTペイロードの署名に使用されるプライベートキーのエイリアス名。 |
プライベートキーのパスワード | 通信を安全に行うために必要なキーストアファイルのパスワード。プライベートキーのパスワードは、キーストアのパスワードと同じでなければなりません。 |
アクセストークン | アクセストークンの値。 アクセストークンの値を入力するか、[アクセストークンの生成]をクリックして、アクセストークンの値を指定します。 プロキシサーバーを介してアクセストークンの生成呼び出しを渡すには、Secure Agentプロパティで認証されていないプロキシサーバーを設定する必要があります。接続設定で設定されたプロキシは、アクセストークンの生成呼び出しには適用されません。 |
Swaggerファイルパス | SwaggerファイルまたはOpenAPIファイルのパス。 次のいずれかのファイルパスを指定できます。
例えば、Swaggerファイルのパスは次のようになります。 C:\swagger\sampleSwagger.json ユーザーにはフォルダとファイルの読み取り権限が必要です。 |
プロパティ | 説明 |
---|---|
認証の詳細プロパティ | アクセストークンURLで使用する追加パラメータ。パラメータはJSON形式で定義する必要があります。 例: [\{"Name":"client_id","Value":"abc"},\{"Name":"client_secret","Value":"abc"}] |
トラストストアファイルパス | REST APIとの一方向または双方向の安全な接続を確立するためのTLS証明書を含むトラストストアファイルの絶対パス。各Secure Agentマシンで使用可能なディレクトリパスを指定します。 トラストストアファイル名とパスワードをJVMオプションとして設定することもできますし、証明書を次のディレクトリにインポートすることもできます。 <Secure Agentのインストールディレクトリ>\jre\lib\security\cacerts サーバーレスランタイム環境の場合、サーバーレスエージェントディレクトリでトラストストアファイルパスを指定します。 例: /home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks |
トラストストアのパスワード | SSL証明書を含むトラストストアファイルのパスワード。 トラストストアのパスワードをJVMオプションとして設定することもできます。 |
プロキシタイプ | プロキシのタイプ。 次のいずれかのオプションを選択します。
|
プロキシ構成 | プロキシを設定するために必要な形式。 プロキシは、次の形式を使用して設定することができます: <ホスト>:<ポート> 認証されたプロキシサーバーを設定することはできません。 |
詳細フィールド | エージェントがRESTエンドポイントに接続するときに使用する引数を入力します。 複数の引数を指定する場合は、それぞれの引数をセミコロンで区切ります。 例: connectiondelaytime:10000;retryattempts:5 次のような引数を指定することができます。
デフォルトはエンドポイントAPIで定義されているタイムアウトです。 注: REST V2接続タイムアウトとエンドポイントAPIタイムアウトの両方が定義されている場合、接続は定義されている最短のタイムアウトで終了します。 デフォルトは10000です。 デフォルトは3です。再試行を無効にするには0を指定します。 デフォルトはfalseです。 |
プロパティ | 説明 |
---|---|
キー | REST V2コネクタがRESTエンドポイントに対して実行されるAPI呼び出しを認証するために使用する一意のAPIキー。 |
値 | API呼び出しを実行するために必要なAPIキーに対応する値。 |
APIキーの追加先 | RESTエンドポイントにAPI呼び出しを実行するために、APIキーとそれに対応する値を要求ヘッダーまたはクエリパラメータとして送信する必要があるかどうかを指定します。 次のいずれかのオプションを選択します。
|
Swaggerファイルパス | SwaggerファイルまたはOpenAPIファイルのパス。 次のいずれかのファイルパスを指定できます。
例えば、Swaggerファイルのパスは次のようになります。 C:\swagger\sampleSwagger.json ユーザーにはフォルダとファイルの読み取り権限が必要です。 |
プロパティ | 説明 |
---|---|
トラストストアファイルパス | REST APIとの一方向または双方向の安全な接続を確立するためのTLS証明書を含むトラストストアファイルの絶対パス。各Secure Agentマシンで使用可能なディレクトリパスを指定します。 トラストストアファイル名とパスワードをJVMオプションとして設定することもできますし、証明書を次のディレクトリにインポートすることもできます。 <Secure Agentのインストールディレクトリ>\jre\lib\security\cacerts サーバーレスランタイム環境の場合、サーバーレスエージェントディレクトリでトラストストアファイルパスを指定します。 例: /home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks |
トラストストアのパスワード | SSL証明書を含むトラストストアファイルのパスワード。 トラストストアのパスワードをJVMオプションとして設定することもできます。 |
キーストアファイルパス | REST APIとの双方向の安全な接続を確立するために必要なキーと証明書を含むキーストアファイルの絶対パス。各Secure Agentマシンで使用可能なディレクトリパスを指定します。 また、キーストアファイル名とパスをJVMオプションとして設定するか、証明書を任意のディレクトリにインポートすることもできます。 サーバーレスランタイム環境の場合、サーバーレスエージェントディレクトリでキーストアファイルパスを指定します。 例: /home/cldagnt/SystemAgent/serverless/configurations/ssl_store/<cert_name>.jks |
キーストアのパスワード | 通信を安全に行うために必要なキーストアファイルのパスワードです。 キーストアのパスワードをJVMオプションとして設定することもできます。 |
プロキシタイプ | プロキシのタイプ。 次のいずれかのオプションを選択します。
|
プロキシ構成 | プロキシを設定するために必要な形式。 次の形式を使用してプロキシを設定します: <ホスト>:<ポート> 認証されたプロキシサーバーを設定することはできません。 |
詳細フィールド | エージェントがRESTエンドポイントに接続するときに使用する引数を入力します。 複数の引数を指定する場合は、それぞれの引数をセミコロンで区切ります。 例: connectiondelaytime:10000;retryattempts:5 次のような引数を指定することができます。
デフォルトはエンドポイントAPIで定義されているタイムアウトです。 注: REST V2接続タイムアウトとエンドポイントAPIタイムアウトの両方が定義されている場合、接続は定義されている最短のタイムアウトで終了します。 デフォルトは10000です。 デフォルトは3です。再試行を無効にするには0を指定します。 デフォルトはfalseです。 |