APIを使用した特権コンソールの設定

この記事では、APIを使用してZscaler Private Access (ZPA)特権コンソールを管理する方法について説明します。すべてのAPIはレート制限されています。詳細は、「レート制限について」を参照してください。

前提条件のAPI呼び出し

新規特権コンソールを作成する前に、特権リモート アクセス(PRA)が有効になっているApplication Segmentの詳細を取得する必要があります。詳細は、「APIを使用したApplication Segmentの設定」を参照してください。

新規特権コンソールの作成

新規特権コンソールを作成するには、以下の手順を実行します。

  1. 特権コンソール コントローラーの/mgmtconfig/v1/admin/customers/{customerId}/praConsoleエンドポイントにPOSTリクエスト送信します。
  2. 要求エンドポイントに customerId、顧客の ZPA テナント ID を指定します。

例：/mgmtconfig/v1/admin/customers/217246660302995456/praConsole。

  1. リクエスト ヘッダーを含めて、要求コンテキストに関する次のパラメーターを指定します。
  • コンテンツ タイプ：application/json
  • 認可：Bearer <access_token>
  1. 次のJSONペイロードを使用し、リクエスト本文に次の情報を指定します。
  • 特権コンソールの名前。
  • PRAが有効になっているアプリケーションの詳細。praApplicationモデルが赤で強調表示されます。
  • {
  "enabled": true,
  "name": "string",
  "praApplication": {
    "appId": 0,
    "applicationPort": 0,
    "applicationProtocol": "HTTP",
    "connectionSecurity": "ANY",
    "domain": "string",
    "enabled": true,
    "hidden": true,
    "id": 0,
    "name": "string"
  },
  "praPortals": [
    {
      "certificateId": 0,
      "certificateName": "string",
      "domain": "string",
      "enabled": true,
      "id": 0,
      "name": "string",
      "userNotificationEnabled": true
    }
  ]
}
    閉じる
  • [
   {
      "enabled":true,
      "name":"Test PRA Console",
      "description":"",
      "PraPortals":[
         {
            "id":"72057594038076717",
            "modifiedTime":"1651391898",
            "creationTime":"1651391879",
            "modifiedBy":"72057594038073668",
            "name":"Test",
            "enabled":true,
            "certificateId":"72057594038037594",
            "certificateName":"1daycert1",
            "cName":"72057594038076717.72057594037927936.pra.d.zpa-app.net",
            "domain":"testurl.com",
            "userNotification":"Welcome :",
            "userNotificationEnabled":true
         }
      ],
      "PraApplication":{
         "id":"72057594038656944"
      }
   }
]
    閉じる
  • [
   {
      "id":"72057594038660861",
      "modifiedTime":"1686678719",
      "creationTime":"1686678719",
      "modifiedBy":"72057594038040687",
      "name":"Test PRA Console",
      "enabled":true,
      "PraApplication":{
         "id":"72057594038656944",
         "modifiedTime":"1685472255",
         "creationTime":"1685472255",
         "modifiedBy":"72057594038609323",
         "name":"pra-app-add",
         "enabled":true,
         "domain":"pra-app-add",
         "appId":"72057594038656942",
         "hidden":false,
         "applicationProtocol":"SSH",
         "applicationPort":"22"
      },
      "PraPortals":[
         {
            "id":"72057594038076717",
            "modifiedTime":"1651391898",
            "creationTime":"1651391879",
            "modifiedBy":"72057594038073668",
            "name":"Test",
            "enabled":true,
            "certificateId":"72057594038037594",
            "certificateName":"1daycert1",
            "cName":"72057594038076717.72057594037927936.pra.d.zpa-app.net",
            "domain":"testurl.com",
            "userNotification":"Welcome :",
            "userNotificationEnabled":true
         }
      ]
   }
]
    閉じる

応答が成功すると、コード201が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

マイクロテナントのサポート

マイクロテナント内に新規特権コンソールを作成するには、以下の手順を実行します。

  1. 特権コンソール コントローラーの/mgmtconfig/v1/admin/customers/{customerId}/praConsole?microtenantId={microtenantId}エンドポイントにPOSTリクエストを送信します。
  2. 要求エンドポイントで以下を入力します。

例：mgmtconfig/v1/admin/customers/145260601092866048/praConsole?microtenantId=145260601092866314。

  1. リクエスト ヘッダーを含めて、要求コンテキストに関する次のパラメーターを指定します。
  • コンテンツ タイプ：application/json
  • 認可：Bearer <access_token>
  1. 次のJSONペイロードを使用し、リクエスト本文に次の情報を指定します。
  • 特権コンソールの名前。
  • PRAが有効になっているアプリケーションのID。

  • {
  "id": "145260601092866537",
  "modifiedTime": "1705617359",
  "creationTime": "1705617359",
  "modifiedBy": "145260601092866482",
  "name": "10.10.10.10",
  "enabled": true,
  "praApplication": {
    "id": "145260601092866519",
    "modifiedTime": "1705615436",
    "creationTime": "1705083996",
    "modifiedBy": "145260601092866482",
    "name": "10.10.10.10",
    "enabled": true,
    "domain": "10.10.10.10",
    "appId": "145260601092866518",
    "hidden": false,
    "applicationProtocol": "SSH",
    "applicationPort": "22",
    "microtenantName": "Default"
  },
  "praPortals": [
    {
      "id": "145260601092866325",
      "enabled": true
    }
  ],
  "microtenantId": "145260601092866314"
}
    閉じる

応答が成功すると、コード201が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

PRAコンソールのリストの作成

PRAコンソールのリストを作成するには、以下の手順を実行します。

  1. 特権コンソール コントローラーの/mgmtconfig/v1/admin/customers/{customerId}/praConsole/bulkエンドポイントにPOSTリクエストを送信します。
  2. 要求エンドポイントに customerId、顧客の ZPA テナント ID を指定します。

例：/mgmtconfig/v1/admin/customers/217246660302995456/praConsole/bulk。

  1. リクエスト ヘッダーを含めて、要求コンテキストに関する次のパラメーターを指定します。
  • コンテンツ タイプ：application/json
  • 認可：Bearer <access_token>
  1. 次のJSONペイロードを使用し、リクエスト本文に次の情報を指定します。
  • 特権コンソールの名前。
  • PRAが有効になっているアプリケーションのID。
  • [
  {
  "enabled": true,
  "name": "string",
  "praApplication": {
    "appId": 0,
    "applicationPort": 0,
    "applicationProtocol": "HTTP",
    "connectionSecurity": "ANY",
    "domain": "string",
    "enabled": true,
    "hidden": true,
    "id": 0,
    "name": "string"
  },
  "praPortals": [
    {
      "certificateId": 0,
      "certificateName": "string",
      "domain": "string",
      "enabled": true,
      "id": 0,
      "name": "string",
      "userNotificationEnabled": true
    }
  ]
}
]
    閉じる
  • [
  {
    "enabled": true,
    "name": "testvnc.com",
    "description": "",
    "praPortals": [
      {
        "id": "289370814522851478",
        "creationTime": "1649156687",
        "modifiedBy": "72057594038050500",
        "name": "test2",
        "enabled": true,
        "certificateId": "289370814522851367",
        "certificateName": "portaltest",
        "cName": "289370814522851478.289370814522851328.h.d.zpa-app.net",
        "domain": "portalabc.com",
        "userNotificationEnabled": false
      }
    ],
    "praApplication": {
      "id": "289370814522851493"
    }
  }
]
    閉じる
  • [
  {
    "id": "289370814522851639",
    "creationTime": "1668439345",
    "modifiedBy": "72057594038624153",
    "name": "testvnc.com",
    "enabled": true,
    "praApplication": {
      "id": "289370814522851493",
      "creationTime": "1654158837",
      "modifiedBy": "72057594038050500",
      "name": "testvnc.com",
      "enabled": true,
      "domain": "testvnc.com",
      "appId": "289370814522851492",
      "hidden": false,
      "applicationProtocol": "SSH",
      "applicationPort": "22"
    },
    "praPortals": [
      {
        "id": "289370814522851478",
        "creationTime": "1649156687",
        "modifiedBy": "72057594038050500",
        "name": "test2",
        "enabled": true,
        "certificateId": "289370814522851367",
        "certificateName": "portaltest",
        "cName": "289370814522851478.289370814522851328.h.d.zpa-app.net",
        "domain": "portalabc.com",
        "userNotificationEnabled": false
      }
    ]
  }
]
    閉じる

応答が成功すると、コード201が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

マイクロテナント内のPRAコンソールのリストを作成するには、以下の手順を実行します。

  1. 特権コンソール コントローラーの/mgmtconfig/v1/admin/customers/{customerId}/praConsole/bulk?microtenantId={microtenantId}エンドポイントにPOSTリクエストを送信します。
  2. 要求エンドポイントで以下を入力します。

例：/mgmtconfig/v1/admin/customers/{customerId}/praConsole/bulk?microtenantId=145260601092866314。

  1. リクエスト ヘッダーを含めて、要求コンテキストに関する次のパラメーターを指定します。
  • コンテンツ タイプ：application/json
  • 認可：Bearer <access_token>
  1. 次のJSONペイロードを使用し、リクエスト本文に次の情報を指定します。
  • 特権コンソールの名前。
  • PRAが有効になっているアプリケーションのID。
  • 特権ポータルのID。

  • [
  {
    "id": "145260601092866538",
    "modifiedTime": "1705618822",
    "creationTime": "1705618822",
    "modifiedBy": "145260601092866482",
    "name": "10.10.10.10",
    "enabled": true,
    "praApplication": {
      "id": "145260601092866519",
      "modifiedTime": "1705615436",
      "creationTime": "1705083996",
      "modifiedBy": "145260601092866482",
      "name": "10.10.10.10",
      "enabled": true,
      "domain": "10.10.10.10",
      "appId": "145260601092866518",
      "hidden": false,
      "applicationProtocol": "SSH",
      "applicationPort": "22",
      "microtenantName": "Default"
    },
    "praPortals": [
      {
        "id": "145260601092866325",
        "enabled": true
      }
    ],
    "microtenantId": "145260601092866314"
  }
]
    閉じる

応答が成功すると、コード201が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

すべてのPRAコンソールの詳細の取得

特定の顧客のすべてのPRAコンソールの詳細を取得するには、以下の手順を実行します。

  1. 特権コンソール コントローラーの/mgmtconfig/v1/customers/{customerId}/praConsoleエンドポイントにGETリクエストを送信します。
  2. 要求エンドポイントに customerId、顧客の ZPA テナント ID を指定します。

例：/mgmtconfig/v1/customers/145256180497776640/praConsole。

  • {
  "id": "289370814522851651",
  "creationTime": "1669638768",
  "modifiedBy": "72057594038624153",
  "name": "tsett.com",
  "enabled": true,
  "praApplication": {
    "id": "289370814522851417",
    "modifiedTime": "1637356774",
    "creationTime": "1637356460",
    "modifiedBy": "72057594038006701",
    "name": "tsett.com",
    "enabled": true,
    "domain": "tsett.com",
    "appId": "289370814522851416",
    "hidden": false,
    "applicationProtocol": "RDP",
    "applicationPort": "3389",
    "connectionSecurity": "TLS"
  },
  "praPortals": [
    {
      "id": "289370814522851473",
      "modifiedTime": "1665565095",
      "creationTime": "1642045470",
      "modifiedBy": "72057594038620387",
      "name": "test100",
      "enabled": true,
      "certificateId": "289370814522851367",
      "certificateName": "portaltest",
      "cName": "289370814522851473.289370814522851328.h.d.zpa-app.net",
      "domain": "test100.com",
      "userNotificationEnabled": true
    }
  ]
}
    閉じる

レスポンスが成功すると、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

このAPIはページネーションをサポートしています。ページネートされた応答を取得する手順は次の通りです。

  1. 特権コンソール コントローラーの/mgmtconfig/v1/admin/customers/{customerId}/praConsole?page=1&pagesize=20エンドポイントにGETリクエストを送信します。
  2. 要求エンドポイントで以下を入力します。
  • customerId:顧客のZPAテナントID。
  • 有効なページ値とページ サイズ値。

例：/mgmtconfig/v1/customers/145256180497776640/praConsole?page=1&pagesize=20。

  • {
  "totalPages": "1",
  "list": [
    {
      "id": "145256180497776670",
      "creationTime": "1639088246",
      "modifiedBy": "72057594038048819",
      "name": "eng-workstation.sahuhaus.local",
      "enabled": true,
      "praApplication": {
        "id": "145256180497776669",
        "creationTime": "1639088219",
        "modifiedBy": "72057594038048819",
        "name": "eng-workstation.sahuhaus.local",
        "enabled": true,
        "domain": "eng-workstation.sahuhaus.local",
        "appId": "145256180497776668",
        "hidden": false,
        "applicationProtocol": "RDP",
        "applicationPort": "3389",
        "connectionSecurity": "ANY"
      },
      "praPortals": [
        {
          "id": "145256180497776653",
          "modifiedTime": "1665520467",
          "creationTime": "1636745350",
          "modifiedBy": "72057594038006701",
          "name": "ZeroTrust Dev Portal",
          "enabled": true,
          "description": "&amp;&lt;&gt;",
          "certificateId": "145256180497776652",
          "domain": "portal-dev.zerotrust.to",
          "userNotification": "Welcome to the OT Portal for the Houston Site!",
          "userNotificationEnabled": true
        }
      ]
    }
  ]
}
    閉じる

指定しない場合、デフォルトのページ サイズは20です。最大ページ サイズは500です。

レスポンスが成功すると、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

このAPIはマイクロテナントをサポートします。マイクロテナントのすべてのPRAコンソールの詳細を取得するには、以下の手順を実行します。

  1. 特権コンソールコントローラーの/mgmtconfig/v1/admin/customers/{customerId}/praConsole?microtenantId={microtenantId}エンドポイントにGETリクエストを送信します。
  2. 要求エンドポイントで以下を入力します。
  • customerId:顧客のZPAテナントID。
  • [microtenantId]: ZPAテナント用マイクロテナントの一意の識別子。詳細は、「APIを使用したマイクロテナントの設定」を参照してください。
  • 有効なページ値とページ サイズ値。

  • {
  "totalPages": "1",
  "totalCount": "1",
  "list": [
    {
      "id": "145260601092866331",
      "modifiedTime": "1698124810",
      "creationTime": "1698124810",
      "modifiedBy": "72057594038068982",
      "name": "monica-scope-c-ssh.com",
      "enabled": true,
      "praApplication": {
        "id": "145260601092866329",
        "modifiedTime": "1698124747",
        "creationTime": "1698124747",
        "modifiedBy": "72057594038068982",
        "name": "monica-scope-c-ssh.com",
        "enabled": true,
        "domain": "monica-scope-c-ssh.com",
        "appId": "145260601092866327",
        "hidden": false,
        "applicationProtocol": "SSH",
        "applicationPort": "22",
        "microtenantId": "145260601092866314"
      },
      "praPortals": [
        {
          "id": "145260601092866325",
          "modifiedTime": "1698124586",
          "creationTime": "1698124586",
          "modifiedBy": "72057594038068982",
          "name": "Scope C Portal",
          "enabled": true,
          "certificateId": "145260601092866074",
          "domain": "pra-portal-otdev-scope-c.com",
          "userNotificationEnabled": false,
          "microtenantId": "145260601092866314"
        }
      ],
      "microtenantId": "145260601092866314"
    }
  ]
}
    閉じる

レスポンスが成功すると、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

特定の特権コンソールの詳細の取得

特定の顧客に対して特定のPRAコンソールを設定するには、次の手順を実行します。

  1. 特権コンソール コントローラーの/mgmtconfig/v1/admin/customers/{customerId}/praConsole/{id}エンドポイントにGETリクエストを送信します。
  2. 要求エンドポイントに customerId、顧客の ZPA テナント ID を指定します。

例：mgmtconfig/v1/admin/customers/289370814522851328/praConsole/289370814522851460。

  • {
  "id": "289370814522851460",
  "creationTime": "1637816978",
  "modifiedBy": "72057594038006701",
  "name": "10.12.12.23",
  "enabled": true,
  "praApplication": {
    "id": "289370814522851443",
    "creationTime": "1637438036",
    "modifiedBy": "72057594038006701",
    "name": "10.12.12.23",
    "enabled": true,
    "domain": "10.12.12.23",
    "appId": "289370814522851442",
    "hidden": false,
    "applicationProtocol": "RDP",
    "applicationPort": "3389",
    "connectionSecurity": "ANY"
  },
  "praPortals": [
    {
      "id": "289370814522851476",
      "modifiedTime": "1665563899",
      "creationTime": "1646066550",
      "modifiedBy": "72057594038050500",
      "name": "portaltest",
      "enabled": true,
      "description": "ab&amp;&lt;&gt;c",
      "certificateId": "289370814522851367",
      "domain": "portaltest.com",
      "userNotificationEnabled": false
    }
  ]
}
    閉じる

レスポンスが成功すると、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

このAPIは、マイクロテナント内のPRAコンソールの詳細の取得をサポートします。マイクロテナント内のPRAコンソールの詳細を取得するには、以下の手順を実行します。

  1. 特権コンソール コントローラーの次の/mgmtconfig/v1/admin/customers/{customerId}/praConsole/{id}?microtenantId={microtenantId}エンドポイントにGETリクエストを送信します。
  2. 要求エンドポイントで以下を入力します。

例：/mgmtconfig/v1/admin/customers/{customerId}/praConsole/{id}?microtenantId=145260601092866314。

  • {
  "id": "145260601092866536",
  "modifiedTime": "1705608783",
  "creationTime": "1705608783",
  "modifiedBy": "145260601092866482",
  "name": "10.10.10.10",
  "enabled": true,
  "praApplication": {
    "id": "145260601092866519",
    "modifiedTime": "1705083996",
    "creationTime": "1705083996",
    "modifiedBy": "72057594038608958",
    "name": "10.10.10.10",
    "enabled": true,
    "domain": "10.10.10.10",
    "appId": "145260601092866518",
    "hidden": false,
    "applicationProtocol": "SSH",
    "applicationPort": "22"
  },
  "praPortals": [
    {
      "id": "145260601092866325",
      "modifiedTime": "1698124586",
      "creationTime": "1698124586",
      "modifiedBy": "72057594038068982",
      "name": "Scope C Portal",
      "enabled": true,
      "certificateId": "145260601092866074",
      "domain": "pra-portal-otdev-scope-c.com",
      "userNotificationEnabled": false,
      "microtenantId": "145260601092866314"
    }
  ],
  "microtenantId": "145260601092866314"
}
    閉じる

レスポンスが成功すると、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

特権ポータルの特権コンソールの取得

特定の特権ポータルの特権コンソールを取得するには、以下の手順を実行します。

  1. 特権コンソール コントローラーの/mgmtconfig/v1/admin/customers/{customerId}/praConsole/praPortal/{portalId}エンドポイントにGETリクエストを送信します。
  2. 要求エンドポイントで以下を入力します。
  • customerId:顧客のZPAテナントID。
  • [portalId]:特権ポータルの一意の識別子。詳細は、「APIを使用した特権ポータルの設定」を参照してください。
  • 有効なページ値とページ サイズ値。

例：mgmtconfig/v1/admin/customers/145256180497776640/praConsole/praPortal/145256180497776653?page=1&pagesize=20。

  • {
  "totalPages": "1",
  "list": [
    {
      "id": "145256180497776908",
      "creationTime": "1675971235",
      "modifiedBy": "72057594038006701",
      "name": "1.1.1.122",
      "enabled": true,
      "praApplication": {
        "id": "145256180497776887",
        "modifiedTime": "1674584300",
        "creationTime": "1674584177",
        "modifiedBy": "72057594038006701",
        "name": "1.1.1.122",
        "enabled": true,
        "domain": "1.1.1.122",
        "appId": "145256180497776882",
        "hidden": false,
        "applicationProtocol": "SSH",
        "applicationPort": "22"
      },
      "praPortals": [
        {
          "id": "145256180497776653",
          "modifiedTime": "1665520467",
          "creationTime": "1636745350",
          "modifiedBy": "72057594038006701",
          "name": "Example Sample Portal",
          "enabled": true,
          "description": "&amp;&lt;&gt;",
          "certificateId": "145256180497776652",
          "domain": "portal-sample.example.to",
          "userNotification": "Welcome to the OT Portal for the Houston Site!",
          "userNotificationEnabled": true
        }
      ]
    },
    {
      "id": "145256180497776670",
      "creationTime": "1639088246",
      "modifiedBy": "72057594038048819",
      "name": "example-workstation.sample.local",
      "enabled": true,
      "praApplication": {
        "id": "145256180497776669",
        "creationTime": "1639088219",
        "modifiedBy": "72057594038048819",
        "name": "example-workstation.sample.local",
        "enabled": true,
        "domain": "example-workstation.sample.local",
        "appId": "145256180497776668",
        "hidden": false,
        "applicationProtocol": "RDP",
        "applicationPort": "3389",
        "connectionSecurity": "ANY"
      },
      "praPortals": [
        {
          "id": "145256180497776653",
          "modifiedTime": "1665520467",
          "creationTime": "1636745350",
          "modifiedBy": "72057594038006701",
          "name": "Example Sample Portal",
          "enabled": true,
          "description": "&amp;&lt;&gt;",
          "certificateId": "145256180497776652",
          "domain": "portal-sample.example.to",
          "userNotification": "Welcome to the Sample Portal for the Example Site!",
          "userNotificationEnabled": true
        }
      ]
    },
    {
      "id": "145256180497776903",
      "creationTime": "1675726124",
      "modifiedBy": "72057594038006701",
      "name": "testapp4.com",
      "enabled": true,
      "praApplication": {
        "id": "145256180497776776",
        "modifiedTime": "1666224661",
        "creationTime": "1666224569",
        "modifiedBy": "72057594038006701",
        "name": "testapp4.com",
        "enabled": true,
        "domain": "testapp4.com",
        "appId": "145256180497776741",
        "hidden": false,
        "applicationProtocol": "SSH",
        "applicationPort": "22"
      },
      "praPortals": [
        {
          "id": "145256180497776653",
          "modifiedTime": "1665520467",
          "creationTime": "1636745350",
          "modifiedBy": "72057594038006701",
          "name": "Sample Example Portal",
          "enabled": true,
          "description": "&amp;&lt;&gt;",
          "certificateId": "145256180497776652",
          "domain": "portal-sample.example.to",
          "userNotification": "Welcome to the Sample Portal for the Example Site!",
          "userNotificationEnabled": true
        }
      ]
    },
    {
      "id": "145256180497776900",
      "creationTime": "1675726036",
      "modifiedBy": "72057594038006701",
      "name": "testapp5.com",
      "enabled": true,
      "praApplication": {
        "id": "145256180497776778",
        "creationTime": "1666289492",
        "modifiedBy": "72057594038006701",
        "name": "testapp5.com",
        "enabled": true,
        "domain": "testapp5.com",
        "appId": "145256180497776777",
        "hidden": false,
        "applicationProtocol": "SSH",
        "applicationPort": "22"
      },
      "praPortals": [
        {
          "id": "145256180497776653",
          "modifiedTime": "1665520467",
          "creationTime": "1636745350",
          "modifiedBy": "72057594038006701",
          "name": "Sample Example Portal",
          "enabled": true,
          "description": "&amp;&lt;&gt;",
          "certificateId": "145256180497776652",
          "domain": "portal-example.sample.to",
          "userNotification": "Welcome to the Example Portal for the Sample Site!",
          "userNotificationEnabled": true
        }
      ]
    },
    {
      "id": "145256180497776906",
      "creationTime": "1675729013",
      "modifiedBy": "72057594038006701",
      "name": "testapp.com",
      "enabled": true,
      "praApplication": {
        "id": "145256180497776742",
        "modifiedTime": "1667503708",
        "creationTime": "1660089136",
        "modifiedBy": "72057594038006701",
        "name": "testapp.com",
        "enabled": true,
        "domain": "testapp.com",
        "appId": "145256180497776741",
        "hidden": false,
        "applicationProtocol": "SSH",
        "applicationPort": "22"
      },
      "praPortals": [
        {
          "id": "145256180497776653",
          "modifiedTime": "1665520467",
          "creationTime": "1636745350",
          "modifiedBy": "72057594038006701",
          "name": "Example Sample Portal",
          "enabled": true,
          "description": "&amp;&lt;&gt;",
          "certificateId": "145256180497776652",
          "domain": "portal-example.sample.to",
          "userNotification": "Welcome to the Sample Portal for the Example Site!",
          "userNotificationEnabled": true
        }
      ]
    },
    {
      "id": "145256180497776905",
      "creationTime": "1675729013",
      "modifiedBy": "72057594038006701",
      "name": "test-vnc.com",
      "enabled": true,
      "praApplication": {
        "id": "145256180497776787",
        "creationTime": "1667517421",
        "modifiedBy": "72057594038006701",
        "name": "test-vnc.com",
        "enabled": true,
        "domain": "test-vnc.com",
        "appId": "145256180497776786",
        "hidden": false,
        "applicationProtocol": "VNC",
        "applicationPort": "5900"
      },
      "praPortals": [
        {
          "id": "145256180497776653",
          "modifiedTime": "1665520467",
          "creationTime": "1636745350",
          "modifiedBy": "72057594038006701",
          "name": "Sample Portal",
          "enabled": true,
          "description": "&amp;&lt;&gt;",
          "certificateId": "145256180497776652",
          "domain": "portal-example.sample.to",
          "userNotification": "Welcome to the OT Portal for the Houston Site!",
          "userNotificationEnabled": true
        }
      ]
    },
    {
      "id": "145256180497776667",
      "creationTime": "1639086676",
      "modifiedBy": "72057594038048819",
      "name": "ubuntu-desktop.example.local",
      "enabled": true,
      "praApplication": {
        "id": "145256180497776660",
        "modifiedTime": "1639086121",
        "creationTime": "1636745998",
        "modifiedBy": "72057594038048819",
        "name": "ubuntu-desktop.example.local",
        "enabled": true,
        "domain": "ubuntu-desktop.example.local",
        "appId": "145256180497776659",
        "hidden": false,
        "applicationProtocol": "SSH",
        "applicationPort": "22"
      },
      "praPortals": [
        {
          "id": "145256180497776653",
          "modifiedTime": "1665520467",
          "creationTime": "1636745350",
          "modifiedBy": "72057594038006701",
          "name": "ZeroTrust Dev Portal",
          "enabled": true,
          "description": "&amp;&lt;&gt;",
          "certificateId": "145256180497776652",
          "domain": "portal-example.sample.to",
          "userNotification": "Welcome to the Sample Portal for the Example Site!",
          "userNotificationEnabled": true
        }
      ]
    },
    {
      "id": "145256180497776972",
      "creationTime": "1682681529",
      "modifiedBy": "72057594038624153",
      "name": "zscaler.com",
      "enabled": true,
      "praApplication": {
        "id": "145256180497776971",
        "creationTime": "1682681448",
        "modifiedBy": "72057594038624153",
        "name": "zscaler.com",
        "enabled": true,
        "domain": "zscaler.com",
        "appId": "145256180497776970",
        "hidden": false,
        "applicationProtocol": "SSH",
        "applicationPort": "22"
      },
      "praPortals": [
        {
          "id": "145256180497776653",
          "modifiedTime": "1665520467",
          "creationTime": "1636745350",
          "modifiedBy": "72057594038006701",
          "name": "Example Sample Portal",
          "enabled": true,
          "description": "&amp;&lt;&gt;",
          "certificateId": "145256180497776652",
          "domain": "portal-sample.example.to",
          "userNotification": "Welcome to the sSample Portal for the Example Site!",
          "userNotificationEnabled": true
        }
      ]
    }
  ]
}
    閉じる

レスポンスが成功すると、コード200が返されます。詳細は、APIレスポンス コードとエラー メッセージを参照してください。

特権コンソールの更新

特権コンソールを更新するには、以下の手順を実行します。

  1. 特権コンソール コントローラーの/mgmtconfig/v1/admin/customers/{customerId}/praConsole/{id}エンドポイントにPUTリクエストを送信します。
  2. 要求エンドポイントで以下を入力します。

例：/mgmtconfig/v1/admin/customers/289370814522851328/praConsole/289370814522851640。

  1. リクエスト ヘッダーを含めて、要求コンテキストに関する次のパラメーターを指定します。
  • コンテンツ タイプ：application/json
  • 認可：Bearer <access_token>
  1. 次のJSONペイロードを使用し、リクエスト本文に次の情報を指定します。
  • 特権コンソールの名前。
  • PRAが有効になっているアプリケーションのID。
  • 特権ポータルのID。
  • {
  "enabled": true,
  "name": "string",
  "praApplication": {
    "appId": 0,
    "applicationPort": 0,
    "applicationProtocol": "HTTP",
    "connectionSecurity": "ANY",
    "domain": "string",
    "enabled": true,
    "hidden": true,
    "id": 0,
    "name": "string"
  },
  "praPortals": [
    {
      "certificateId": 0,
      "domain": "string",
      "enabled": true,
      "id": 0,
      "name": "string",
      "userNotificationEnabled": true
    }
  ]
}
    閉じる
  • {
  "enabled": true,
  "port": "3389",
  "protocol": "RDP",
  "id": "289370814522851640",
  "creationTime": "1668441154",
  "modifiedBy": "72057594038624153",
  "name": "tsett.com",
  "praApplication": {
    "id": "289370814522851417",
    "modifiedTime": "1637356774",
    "creationTime": "1637356460",
    "modifiedBy": "72057594038006701",
    "name": "tsett.com",
    "enabled": true,
    "domain": "tsett.com",
    "appId": "289370814522851416",
    "hidden": false,
    "applicationProtocol": "RDP",
    "applicationPort": "3389",
    "connectionSecurity": "TLS"
  },
  "praPortals": [
    {
      "id": "289370814522851473"
    }
  ],
  "link": "tsett.com",
  "connectionSecurity": "TLS",
  "description": "Test Console"
}
    閉じる

レスポンスが成功すると、更新が成功したことを意味するコード204が返されます。詳細は、「APIレスポンス コードとエラー メッセージ」を参照してください。

このAPIは、マイクロテナント内の特権コンソールの更新をサポートします。マイクロテナント内の特権コンソールを更新するには、以下の手順を実行します。

  1. 特権コンソール コントローラーの/mgmtconfig/v1/admin/customers/{customerId}/praConsole/{id}?microtenantId={microtenantId}エンドポイントにPUTリクエストを送信します。
  2. 要求エンドポイントで以下を入力します。
  • customerId:顧客のZPAテナントID。
  • [id]:特権コンソールの一意の識別子。
  • [microtenantId]: ZPAテナント用マイクロテナントの一意の識別子。詳細は、「APIを使用したマイクロテナントの設定」を参照してください。

例：/mgmtconfig/v1/admin/customers/145260601092866048/praConsole/145260601092866536?microtenantId=145260601092866314。

  1. リクエスト ヘッダーを含めて、要求コンテキストに関する次のパラメーターを指定します。
  • コンテンツ タイプ：application/json
  • 認可：Bearer <access_token>
  1. 次のJSONペイロードを使用し、リクエスト本文に次の情報を指定します。
  • 特権コンソールの名前。
  • PRAが有効になっているアプリケーションの詳細。
  • 特権ポータルの一意の識別子。

  • {
  "id": "145260601092866536",
  "modifiedTime": "1705613297",
  "creationTime": "1705608783",
  "modifiedBy": "72057594038608958",
  "name": "10.10.10.10",
  "enabled": true,
  "description": "PRA Console",
  "praApplication": {
    "id": "145260601092866519",
    "modifiedTime": "1705083996",
    "creationTime": "1705083996",
    "modifiedBy": "72057594038608958",
    "name": "10.10.10.10",
    "enabled": true,
    "domain": "10.10.10.10",
    "appId": "145260601092866518",
    "hidden": false,
    "applicationProtocol": "SSH",
    "applicationPort": "22"
  },
  "praPortals": [
    {
      "id": "145260601092866325",
      "modifiedTime": "1698124586",
      "creationTime": "1698124586",
      "modifiedBy": "72057594038068982",
      "name": "Scope C Portal",
      "enabled": true,
      "certificateId": "145260601092866074",
      "domain": "pra-portal-example-scope-c.com",
      "userNotificationEnabled": false,
      "microtenantId": "145260601092866314"
    }
  ],
  "microtenantId": "145260601092866314"
}
    閉じる

レスポンスが成功すると、更新が成功したことを意味するコード204が返されます。詳細は、「APIレスポンス コードとエラー メッセージ」を参照してください。

特権コンソールの削除

特権コンソールを削除するには、以下の手順を実行します。

  1. 特権コンソール コントローラーの/mgmtconfig/v1/admin/customers/{customerId}/praConsole/{id}エンドポイントにDELETEリクエストを送信します。
  2. 要求エンドポイントで以下を入力します。

例：/mgmtconfig/v1/admin/customers/289370814522851328/praConsole/289370814522851640。

レスポンスが成功すると、削除が成功したことを意味するコード204No Contentが返されます。詳細は、「APIレスポンス コードとエラー メッセージ」を参照してください。

このAPIは、マイクロテナント内の特権コンソールを削除するためのサポートを提供します。マイクロテナント内の特権コンソールを削除するには、以下の手順を実行します。

  1. 特権コンソール コントローラーの次の/mgmtconfig/v1/admin/customers/{customerId}/praConsole/{id}?microtenantId={microtenantId}エンドポイントにDELETEリクエストを送信します。
  2. 要求エンドポイントで以下を入力します。

例：/mgmtconfig/v1/admin/customers/289370814522851328/praConsole/289370814522851640?microtenantId=145260601092866314。

レスポンスが成功すると、削除が成功したことを意味するコード204が返されます。詳細は、「APIレスポンス コードとエラー メッセージ」を参照してください。

フィールド説明の追加

次のテーブルに、特権コンソールのユース ケースで使用できるフィールドの説明を示します。

フィールド説明必須値
CustomerIDZPAテナントの一意の識別子はい整数
ページページ番号の指定いいえ整数
pagesizeページ サイズの指定いいえ整数
検索機能またはフィールドによる検索をサポートするために使用される検索文字列を示します。いいえ文字列
microtenantIdZPAテナント用マイクロテナントの一意の識別子。マイクロテナント内にいる場合は、そのマイクロテナントからデータを取得するAPIコールを行うときにmicrotenantIdフィールドを渡す必要があります。microtenantIdはAPIキーページで取得することも、ZPA クラウドサービスAPIを使用してプログラムで取得することもできます。マイクロテナント内にいる場合、特定の操作へのアクセスは制限されます。デフォルトのマイクロテナント内にいる場合は、デフォルトのマイクロテナントからデータを取得するリクエストを行うときにmicrotenantIdを0として渡します。テナントに関連付けられているすべての顧客からデータを取得するには、microtenantIdをnullとして渡します。リソースの作成または更新時にmicrotenantIdがリクエスト エンドポイントで渡されない場合、リソースはデフォルトのマイクロテナントで作成または更新されます。詳細は、「APIを使用したマイクロテナントの設定」を参照してください。いいえ整数