クライアント用REST API v2

REST API v2を使用して、Netskope Clientの表示、作成、読む、更新、削除（CRUD）操作を行うことができるようになりました。APIを使用して、繰り返しの変更を自動化し、組織単位（OU）およびグループ間で構成を一貫させ、それらの構成を独自のツールおよびスクリプトに接続します。詳細については、Settings > Tools > REST API v2 > API DocumentationにアクセスしてSwaggerドキュメントを参照してください。

Prerequisites

REST API v2を使用してClientを管理する前に、以下を用意してください：

• エンドポイントがテナントで利用可能であることを確認します。Settings > Tools > REST API v2 > API Documentationに移動し、APIセットの特定のセクションを検索します。例えば、クライアント構成の場合は、clientconfiguraationセクションを検索します。

• サービスアカウントから有効なREST API v2トークンを取得してください。サービスアカウントはSettings > Administration > Administrators & Roles > Administratorsで作成できます。すべてのリクエストにトークンを含めます：[ヘッダーを確認：Authorization: Bearer <token> または Netskope-Api-Token: <token>]。詳細については、REST API v2の概要をご覧ください。

• サービスアカウントのロールに、読み取り操作には「閲覧」アクセス権、作成、更新、削除操作には「管理」アクセス権があることを確認します。API呼び出しにはロールベースのアクセス制御が適用されます。詳細については、RBAC-ロールベースアクセス制御の設定をご覧ください。

• Allowlist API client source IP addresses. IP制限が有効な場合は、REST API v2のスクリプトと統合が許可された送信元IPアドレスから接続されていることを確認してください：

  • サービスアカウントに割り当てられたロールに対してロールベースのIP許可リストが有効になっている場合は、送信元IPアドレスをその許可リストに追加します。ロールベースの許可リストはグローバルIP許可リストよりも優先されるため、グローバルなカスタムIPリストにアドレスを追加してもアクセスは許可されません。

  • 役割ベースの許可リストが適用されない場合は、送信元IPアドレスをSettings > Administration > IP Allowlistの下のカスタムIPリストに追加します。これは、グローバルIP許可リストが有効な場合に適用されます。

• 設定する機能に関連する機能がテナントで有効になっていることを確認してください。一部の設定は、対応するテナント機能が有効になっている場合にのみ使用できます。

すべてのリクエストでこのベースURLが使用されます。

https://<tenant-name>.goskope.com/api/v2/

このトピックのすべてのエンドポイントパスは、このベースURLに関連しています。たとえば、clientconfiguration/client/configはhttps://<tenant-name>.goskope.com/api/v2/clientconfiguration/client/configを意味します。curlの例は完全なURLを示しています。 <tenant-name>をテナント名に置き換えます。

トークンをすべてのリクエストのAuthorizationヘッダーにAuthorization: Bearer <token>の形式で送信します。

Client Configurations Using REST API v2

Netskope UIにサインインせずに、REST API v2を使用してNetskope Clientの構成をプログラムで管理します。Settings > Tools > REST API v2 > API Documentationに移動し、Client ConfigurationのREST API v2セットについてclientconfigurationセクションを検索します。

Endpoints

すべてのパスは次からの相対パスです：

/api/v2/clientconfiguration

Client Configurations Endpoints

この表には、クライアント構成で利用可能なREST API v2エンドポイントがリストされています。

方法	Endpoint	デスクリプション
得る	/client/config	Client構成の一覧を表示します。名前による検索、ページ分割、ターゲットによるフィルタリングをサポートしています。
役職	/client/config	クライアント構成を作成します。
得る	/client/config/{id}	1つのClient設定を返します。
パッチ	/client/config/{id}	送信したフィールドのみを更新します。
DELETE	/client/config/{id}	1つのClient構成を削除します。
役職	/client/config/bulkdelete	デフォルト以外のすべての構成を削除する非同期ジョブを始める。
得る	/client/config/bulkstatus/{jobid}	一括削除ジョブの状態を返します。
得る	/client/versions	更新ポリシーで使うできるClientのバージョンを一覧表示します。
得る	/client/platforms	ワンタイム無効化でサポートされているプラットフォームと最小クライアントバージョンをリストします。
得る	/client/gslbpops	クライアント設定ゾーンの選択に利用可能なGSLBゾーンオプションとそのUUIDを一覧表示します。
得る	/client/config/swgglobalattributes	テナントのすべてのインターネットセキュリティグローバル属性の現在の状態を返します。
パッチ	/client/config/swgglobalattributes	1つ以上のインターネットセキュリティグローバル属性をオンまたはオフにします。