OneAPI
OneAPIについて
Zscaler OneAPIは、すべての製品でのAPI設計とエクスペリエンスの一貫性、信頼性、APIの高パフォーマンスを備えたさまざまなZscalerサービスへのプログラムによるアクセスを提供します。これにより、API認証、テナント アクセス ポリシーと管理、レート制限、キャッシング、APIライフサイクル管理など、APIの主要なコンポーネントと機能を一元管理できるため、一貫性のある統一された製品間のAPIエクスペリエンスが提供され、自動化と外部サービスとの統合のための強化されたサポートが提供されます。
OneAPIにアクセスするには、Zscalerアカウント チームにお問い合わせください。
APIを使用する前に、Zscalerでは、前提条件、認証、API呼び出しの方法に関する情報について、「はじめに」を確認することをお勧めします。利用可能なすべてのAPI呼び出し、エンドポイント、パラメーターの詳細は、「OneAPIエンドポイントについて」に一覧表示されているリファレンス ガイドを参照してください。エンドポイントで使用されるレート制限のサマリーについては、「レート制限について」を参照してください。Postmanアプリケーションを使用してAPI呼び出しのリクエストとレスポンスを試すには、「Postman REST APIクライアントの設定」を参照してください。
Zscalerは、OneAPIエンドポイントで使用されるリクエスト パラメーターとレスポンス パラメーターを定期的に更新できます。APIエンドポイントの使用で問題が発生した場合は、Zscalerサポートにお問い合わせください。
次のセクションでは、OneAPIを使用してアクセスおよび管理できるさまざまなZscalerサービスの機能について説明します。
ZIA API
Zscaler Internet Access (ZIA) APIエンドポイントを使用すると、次のZIA機能をプログラムで管理できます。
- アクティベーション
構成の変更を有効にするには、変更をアクティブ化する必要があります。アクティベーションAPIリソースを使用すると、構成の変更をCentral Authority (CA)にプッシュしてアクティブ化できます。
閉じる - 管理監査ログ
すべてのポリシー変更とAPI呼び出しを含む、CSV形式の管理監査ログ レポートをダウンロードしてエクスポートできます。監査ログ レポートは過去6か月間保存され、一度に最大31日間または最大1,000件のレコードのレポートをダウンロードできます。
閉じる - 管理者とロール管理
管理者およびロール管理APIリソースを使用すると、管理者がZIA管理ポータルで持つアクセス レベルを決定する管理者ロール情報を取得できます。これらのリソースを使用すると、組織内の管理者を追加、更新または削除することもできます。
閉じる - ブラウザー分離
- データ損失防止(DLP)
データ損失防止(DLP) APIリソースを使用すると、DLP辞書、エンジン、インシデント レシーバー、インターネット コンテンツ アダプテーション プロトコル(ICAP)サーバーなどの情報を取得できます。さらに、DLP定義済み辞書、完全データ一致(EDM)およびインデックス文書一致(IDM)辞書、通知、およびポリシー ルールを作成および更新できます。また、カスタムDLPエンジンの作成と削除、定義済みおよびカスタム DLP エンジンの更新、論理演算子を使用したDLP辞書の組み合わせによって形成されたDLPエンジン式の検証を行うこともできます。
閉じる - デバイスグループ
デバイス グループAPIリソースを使用すると、デバイス グループ情報を取得できます。ZIAは、組織内でZscaler Client Connectorが展開済みであるすべてのデバイスのリストを保持しています。これらのデバイスは、OSタイプに基づいて事前定義済みグループに分類されます。
閉じる - イベントログ
クロスドメイン アイデンティティー管理(SCIM)クライアントによって実行されたプロビジョニングとユーザーおよびグループの管理アクティビティーを含むCSV形式のイベント ログ レポートを生成してダウンロードできます。SCIMクライアントのアクティビティーは、Zscalerサービスのユーザーに対してSCIMベースのプロビジョニングが有効になっている場合にのみ記録されます。
閉じる - ファイアウォールポリシー
ファイアウォールポリシーAPIリソースを使用すると、ファイアウォールフィルタリングポリシールールとその基準を作成、読み取り、更新および削除できます。
閉じる - 転送制御ポリシー
転送コントロール ポリシーAPIリソースを使用すると、転送ルールを作成、変更、取得および削除できますさらに、これらのリソースを使用すると、ZPAの転送ルールで使用されるZscaler Private Access (ZPA)ゲートウェイを作成、変更、取得および削除できます。
閉じる - 中間CA証明書
Zscalerサービスは、完全なSSLプロキシまたは信頼された中間者(MITM)プロキシとして機能することによってSSLインスペクションを実行します。SSLインスペクションを実行するため、Zscalerは、Zscalerまたは組織が発行した認証局(CA)を使用してドメイン証明書(エンドエンティティ証明書)を動的に生成する必要があります。中間CA証明書APIリソースを使用すると、次のことが可能です。
- カスタム中間CA証明書を作成する
- キー ペアを生成する
- 証明書署名リクエスト(CSR)を生成およびダウンロードする
- 署名付き中間CA証明書と証明書チェーンをアップロードします。
- 証明書を確定します。
- 証明書をデフォルトとしてマークします。
- IoTレポート
IoTレポートAPIを使用すると、未認証のWebトラフィックからZscaler AI/MLエンジンによって識別されるデバイス(管理対象外のユーザー デバイス、サーバー、IoTデバイス)のリストを取得できます。また、検出されたデバイスに関する主要なコンテキスト(ロケーション、ML自動ラベル、分類など)を取得することもできます。
閉じる - ロケーション管理とトラフィック転送
ロケーション管理APIリソースを使用すると、Zscalerサービスで定義されたロケーションまたはサブロケーションのすべての属性をリクエストとして取得したり、VPN資格情報または静的IPアドレスを使用してロケーションを追加または更新したり、サブロケーションを追加または更新したり、ロケーションやサブロケーションを削除したりすることができます。
特定の場所のVPN資格情報の取得と更新
Zscalerサービスは、ZIA パブリック サービス エッジまたはセキュアWebゲートウェイを使用して、組織の企業ネットワーク内の内部事情も検査します。トラフィック転送はIPSec VPNトンネリングを通じて有効になり、適切なユーザー資格情報が設定されている必要があります。ロケーション管理エンドポイントを使用すると、特定のロケーションのVPN資格情報を取得・更新できます。
場所のVPN資格情報を取得するには、
/vpnCredentialsエンドポイントを使用します。VPN IDの個々のVPN資格情報を取得および更新するには、/vpnCredentials/{vpnId}エンドポイントを使用します。ユーザーパスワードは、一定期間(例えば30日ごと)にランダムに再生成することができます。
SD-WANパートナー統合のためのIPSec VPNトンネルの管理
この機能に対応するために使用されるAPIリソースは、SD-WANパートナー専用です。
ソフトウェア定義広域ネットワーク(SD-WAN)パートナーAPIキーにより、テクノロジー パートナーはクラウドサービスAPI内のロケーション管理リソースとVPN資格情報リソースにアクセスできるようになります。各パートナーの詳細とSD-WAN展開構成ガイドの詳細は、「SD-WANパートナー サイト」を参照するか、Zscalerビジネス開発にお問い合わせください。
GREトンネル、スタティックIPアドレス、仮想IPアドレスおよびリージョン情報の取得
ZIAを使用すると、静的IPアドレスまたはGREトンネルをセルフ プロビジョニングしてZscalerサービスに接続できます。仮想IPアドレス(VIP)は、IPSec VPNトンネルを確立するために使用されます。トラフィック転送APIリソースを使用すると、セルフ サービスGREトンネル、静的IPプロビジョニング、データ センターVIPおよびリージョン固有の情報を取得できます。
閉じる - ルール ラベル
ルール ラベルAPIリソースを使用すると、ラベルを作成し、URLフィルタリングポリシールールに関連付けることができます。
閉じる - サンドボックスレポート
サンドボックス レポートAPIリソースを使用すると、Zscalerクラウド上の任意の組織から分析のために送信されたファイルの完全または概要のサンドボックス詳細レポートを取得できます。
閉じる - Sandbox設定
Sandbox設定APIリソースを使用すると、各組織は、Sandboxによって行動分析されるファイルのMD5ファイル ハッシュのカスタム ブロックリストを作成および管理できます。カスタムのブロックリストを取得または置換するには、
/behavioralAnalysisAdvancedSettingsエンドポイントを使用します。MD5ファイル ハッシュのクォータ可用性情報を取得するには、/behavioralAnalysisAdvancedSettings/fileHashCountエンドポイントを使用します。最大10,000個のMD5ファイルハッシュをカスタムブロックリストに追加できます。
閉じる - セキュリティポリシー設定
拒否リストは、Zscalerがすべてのインターネット トラフィックをブロックしている悪意のあるURLのリストです。Zscalerは継続的に更新されるグローバル拒否リストを提供し、各組織はカスタムの拒否リストを管理できます。拒否リストを取得または置換するには、
/security/advancedエンドポイントを使用します。拒否リスト内の個々のURLを追加または削除するには、security/advanced/blacklistUrlsエンドポイントを使用します。許可リストは、Zscalerがセキュリティ スキャンから除外するURLのリストです。Zscalerではグローバルの許可リストは提供されませんが、各組織はカスタムの許可リストを管理できます。ローカルの許可リストには、最大255個のURLを含めることができます。許可リストを取得または置換するには、
/securityエンドポイントを使用します。ただし、APIを使用して許可リストに個々のURLを追加または削除することはできません。組織のカスタム拒否リストおよび許可リストについては、すべてのカテゴリー(カスタムおよび事前定義)にわたって最大25,000個のカスタムURLおよびIPアドレスを追加できます。
閉じる - シャドウITレポート
組織内での使用状況に基づいて、Zscalerが認識するクラウド アプリケーションのシャドーITレポートをエクスポートできます。これらのレポートには、クラウド アプリケーションのさまざまなセキュリティ パラメーター、アプリケーションとインタラクトしたユーザーに関する情報、アプリケーションがアクセスされたロケーションのリストおよびアプリケーションの使用状況の詳細(該当する場合)が含まれます。
閉じる - URLカテゴリー
定義済みのURLカテゴリーとカスタムURLカテゴリーは、組織のURLを分類する方法を提供します。URLカテゴリーAPIリソースを使用すると、次のことができます。
- 定義済みURLカテゴリーのURLを追加または削除します。
- 定義済みおよびカスタムのカテゴリーに関する情報を取得します。
- 指定したURLの分類を検索します。
- カスタム カテゴリーを追加・更新・削除します。
- IPアドレスやURLでカスタムカテゴリーを更新します。
- 既存のカスタムURLカテゴリー内のURLに一致するエントリーを検索し、関連するエントリーを単一つのカテゴリーに追加します。
- URLフィルタリングポリシー
URLフィルタリングポリシーAPIリソースを使用すると、サイトのURL分類に基づいてWebコンテンツへのアクセスを管理することで、責任の露出を制限するルールに関する情報を取得および管理できます。
閉じる - ユーザー認証設定
ユーザー認証設定APIリソースを使用すると、URLをCookie認証から除外できます。
閉じる - ユーザー管理
ユーザー管理APIリソースを使用すると、ユーザー、グループ、部署の情報を取得したり、ユーザーを追加、更新、削除したりできます。
閉じる - ワークロード グループ
ワークロード グループAPIリソースを使用すると、ZIA管理ポータルで設定されたワークロード グループに関する情報を取得できます。ワークロード グループは、情報漏洩防止、URLエラー、SSLインスペクション、およびファイアウォール フィルタリング ルールなどのセキュリティ ポリシーの条件として設定できます。
閉じる
ZPA API
Zscaler Private Access (ZPA) APIエンドポイントを使用すると、次のZPA機能をプログラムで管理できます。
- 代替クラウド ドメイン
代替クラウド ドメインAPIリソースを使用すると、代替クラウド ドメインを読み取ることができます。
閉じる - アプリケーションセグメント
Application Segment APIリソースを使用すると、Application Segmentを作成、読み取り、更新、削除できます。
閉じる - セグメント別グループ
セグメント グループAPIリソースを使用すると、セグメント グループを作成、読み取り、更新、削除できます。
閉じる - App Connector
App Connector APIリソースを使用すると、App Connectorを読み取り、更新および削除できます。
閉じる - App Connectorグループ
App ConnectorグループAPIリソースを使用すると、App Connectorグループを作成、読み取り、更新および削除できます。
閉じる - 証明書
証明書APIリソースを使用すると、証明書を作成、読み取り、更新および削除できます。
閉じる - Cloud Connectorグループ
Cloud ConnectorグループAPIリソースを使用すると、Cloud Connectorグループを読み取ることができます。
閉じる - 顧客
カスタマーAPIリソースを使用すると、顧客の認証ドメインを読み取ることができます。
閉じる - 緊急アクセス
緊急アクセスAPIリソースを使用すると、緊急アクセス ユーザーを作成、読み取り、更新、削除できます。
閉じる - 登録証明書
登録証明書APIリソースを使用すると、登録証明書を読み取ることができます。
閉じる - IdPの構成
IdP構成APIリソースを使用すると、IdP構成を読み取ることができます。
閉じる - 分離プロファイル
分離プロファイルAPIリソースを使用すると、分離プロファイルを読み取ることができます。
閉じる - アクセスポリシー
ポリシー設定コントローラーAPIリソースを使用すると、ポリシーへのアクセスを作成・読み取り・更新・削除できます。
閉じる - クライアント転送ポリシー
ポリシー設定コントローラーAPIリソースを使用すると、クライアント転送ポリシーを作成・読み取り・更新・削除できます。
閉じる - タイムアウトポリシー
ポリシー設定コントローラーAPIリソースを使用すると、タイムアウト ポリシーを作成・読み取り・更新・削除できます。
閉じる - AppProtectionポリシー
ポリシー セット コントローラーAPIリソースを使用すると、AppProtection(以前のインスペクション)ポリシーを作成、読み取り、更新、および削除できます。
閉じる - 分離ポリシー
ポリシー セット コントローラーAPIリソースを使用すると、分離ポリシーを作成、読み取り、更新、削除できます。
閉じる - 特権ポリシー
ポリシー セット コントローラーAPIリソースを使用すると、特権資格情報ポリシーを作成、読み取り、更新、および削除できます。
閉じる - リダイレクト ポリシー
ポリシー セット コントローラーAPIリソースを使用すると、リダイレクト ポリシーを作成、読み取り、更新、削除できます。
閉じる - ログ ストリーミング サービス(LSS)構成
LSS構成APIリソースを使用すると、LSS構成を作成、読み取り、更新および削除できます。
閉じる - 機械グループ
マシン グループAPIリソースを使用すると、マシン グループを読み取ることができます。
閉じる - マイクロテナント
マイクロテナント APIリソースを使用すると、マイクロテナントを作成、読み取り、更新および削除できます。
閉じる - ポスチャープロファイル
ポスチャー プロファイルAPIリソースを使用すると、ポスチャー プロファイルを読み取ることができます。
閉じる - 特権承認
特権承認APIリソースを使用すると、特権承認を作成、読み取り、更新、削除できます。
閉じる - 特権コンソール
特権コンソールAPIリソースを使用すると、特権コンソールを作成、読み取り、更新、削除できます。
閉じる - 特権資格情報
特権資格情報APIリソースを使用すると、特権資格情報を作成、読み取り、更新、削除できます。
閉じる - 特権ポータル
特権ポータルAPIリソースを使用すると、特権ポータルを作成、読み取り、更新、削除できます。
閉じる - プロビジョニングキー
プロビジョニングキーAPIリソースを使用すると、プロビジョニングキーを作成、読み取り、更新および削除できます。
閉じる - SAML属性
SAML属性APIリソースを使用すると、SAML属性を読み取ることができます。
閉じる - SCIMの属性
SCIM属性APIリソースを使用すると、SCIM属性を読み取ることができます。
閉じる - SCIMグループ
SCIMグループAPIリソースを使用すると、SCIMグループを読み取ることができます。
閉じる - サーバー
サーバーAPIリソースを使用すると、サーバーの作成、読み取り、更新、削除を行うことができます。
閉じる - サーバー グループ
サーバー グループAPIリソースを使用すると、サーバー グループを作成、読み取り、更新、削除できます。
閉じる - サービス エッジ
ZPA Private Service Edge APIリソースを使用すると、Private Service Edgeを読み取り、更新および削除できます。
閉じる - サービスエッジグループ
ZPA Private Service EdgeグループAPIリソースを使用すると、ZPA Private Service Edgeグループを作成、読み取り、更新および削除できます。
閉じる - 信頼できるネットワーク
信頼できるネットワークAPIリソースを使用すると、信頼できるネットワークを読み取ることができます。
閉じる - バージョンプロファイル
バージョンプロファイルAPIリソースを使用すると、バージョンプロファイルを読み取ることができます。
閉じる
Zscaler Client Connector API
Zscaler Client Connector APIエンドポイントを使用すると、次のZscaler Client Connector機能をプログラムで管理できます。