APIを使用したIPSecトンネルのVPN認証情報の設定
Zscalerサービスは、ZIA Public Service EdgeまたはセキュアWebゲートウェイを使用して、組織の企業ネットワーク内の内部トラフィックを検査します。トラフィック転送はIPSec VPNトンネリングを通じて有効にすることができ、適切なユーザー資格情報が設定されている必要があります。詳しくは、「VPN資格情報について」を参照してください。VPN資格情報の設定と管理に使用されるAPIエンドポイントの詳細については、「APIリファレンス」を参照してください。
ロケーションのVPN認証情報の取得
ロケーションのVPN資格情報を取得するには、GET要求を/vpnCredentials
に送信します。要求内では、次のパラメーターを使用できます。
locationId
:ロケーションID番号を指定すると、要求は特定のロケーションの資格情報を返します。search
:文字列を指定すると、リクエストはcommonName
、fqdn
、ipAddress
、comments
、またはlocationName
フィールドに一致するすべてのVPN認証情報を、部分一致も含めて返送します。type
:文字列を指定すると、リクエストは指定されたタイプの認証情報を取得します。includeOnlyWithoutLocation
: このパラメーターtrue
のブール値が に設定されている場合、要求はどの場所にも関連付けられていない VPN 資格情報を取得します。page
:ページオフセットを指定します。pageSize
:最大1000までページ長を指定します。
Zscaler では、クエリ パラメーターを pageSize
100 より大きく変更するか、クエリ パラメーターを使用して page
すべての結果を反復処理して、最後のページの結果が 100 未満になるまで繰り返すことをお勧めします。
/vpnCredentials
にGETリクエストを送信する場合、セキュリティ上の理由から事前共有キー(PSK)はレスポンスに含まれません。
特定のVPN IDの認証情報の取得
特定のVPN IDの認証情報を取得するには、/vpnCredentials/{vpnId}
にGETリクエストを送信してください。
特定のVPN IDの認証情報の更新
特定のVPN IDの認証情報を更新する方法:
/vpnCredentials/{vpnId}
にPUTリクエストを送信し、Bodyに以下のVPNパラメータを指定します。id
:VPN IDを整数で指定します(例:"72532
")。type
:認証タイプを文字列で指定します(例:"UFQDN
")。fqdn
:このパラメータは、UFQDN
またはXAUTH
認証タイプを使用している場合にのみ必要です。完全修飾ドメイン名を文字列で指定します(例:"testvpn.antest.com
")。
/vpnCredentials/{vpnId}
にPUTリクエストを送信して、fqdn
を更新することはできません。リクエストの中でfqdn
が変更された場合、その変更は無視されます。
comments
:コメントを文字列として追加します(例:"自動作成
" )。pre-shared key
:このキーは、UFQDN
またはIP
認証タイプ(例:"newPassword123!
")を使用している場合のみ必要です。