/mgmtconfig/v1/admin/customers/{customerId}/praConsole/praPortal/{portalId}

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
page
integer($int32)
(query)
Specifies the page number.
Example : 1
pagesize
integer($int32)
(query)
Specifies the page size. If not provided, the default page size is 20. The max page size is 500.
Example : 20
portalId *required
integer($int64)
(path)
The unique identifier of the privileged portal.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
search
string
(query)
The search string used to support search by features and fields for the API.

list
The total list of privileged consoles.

creationTime
integer($int32)
The time the privileged console is created.
description
string
The description of the privileged console.
enabled
boolean
Whether or not the privileged console is enabled.
iconText
string
The privileged console icon. The icon image is converted to base64 encoded text format.
id
integer($int64)
The unique identifier of the privileged console
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The tenant who modified the privileged console.
modifiedTime
integer($int32)
The time the privileged console is modified.
name*
string
The name of the privileged console.
praApplication

appId
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
applicationPort
integer($int32)
The port of the Privileged Remote Access-enabled application.
applicationProtocol
string
The protocol of the Privileged Remote Access-enabled application.
[
...
]
8 items
connectionSecurity
string
The connection security mechanism used when connecting to remote machines.
[
...
]
6 items
creationTime
integer($int32)
The time the Privileged Remote Access-enabled application is created.
description
string
The description of the Privileged Remote Access-enabled application.
domain
string
The domain of the Privileged Remote Access-enabled application.
enabled
boolean
Whether or not the PRA application is enabled.
hidden
boolean
id
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the Privileged Remote Access-enabled application.
modifiedTime
integer($int32)
The time the Privileged Remote Access-enabled application is modified.
name*
string
The name of the Privileged Remote Access-enabled application.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
praPortals

cName
string
The canonical name (CNAME DNS records) associated with the privileged portal.
certificateId
integer($int64)
The unique identifier of the certificate.
certificateName
string
The name of the certificate.
creationTime
integer($int32)
The time the privileged portal is created.
description
string
The description of the privileged portal.
domain
string
The domain of the privileged portal.
enabled
boolean
Whether or not the privileged portal is enabled.
id
integer($int64)
The unique identifier of the privileged portal.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged portal.
modifiedTime
integer($int32)
The time the privileged portal is modified.
name*
string
The name of the privileged portal.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
userNotification
string
The notification message displayed in the banner of the privileged portallink, if enabled.
userNotificationEnabled
boolean
Indicates if the Notification Banner is enabled (true) or disabled (false).
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
totalCount
integer($int64)
The total count of resources per the search feature.
totalPages
integer($int32)
The total number of pages per the pagination attribute.
Responses
Response content type:
Code
200
Description
OK
Example Value
{
  "list": [
    {
      "creationTime": 0,
      "description": "string",
      "enabled": true,
      "iconText": "string",
      "id": 0,
      "inconsistentConfigDetails": {
        "application": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "segmentGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "appConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "baCertificate": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "branchConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "cloudConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "idp": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "location": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "machineGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "postureProfile": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "samlAttributes": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "scimAttributes": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "serverGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "praApplication": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "trustedNetwork": [
          {
            "name": "string",
            "reason": "string"
          }
        ]
      },
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "praApplication": {
        "appId": 0,
        "applicationPort": 0,
        "applicationProtocol": "HTTP",
        "connectionSecurity": "ANY",
        "creationTime": 0,
        "description": "string",
        "domain": "string",
        "enabled": true,
        "hidden": true,
        "id": 0,
        "modifiedBy": 0,
        "modifiedTime": 0,
        "name": "string",
        "microtenantId": 0,
        "microtenantName": "string"
      },
      "praPortals": [
        {
          "cName": "string",
          "certificateId": 0,
          "certificateName": "string",
          "creationTime": 0,
          "description": "string",
          "domain": "string",
          "enabled": true,
          "id": 0,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "microtenantId": 0,
          "microtenantName": "string",
          "userNotification": "string",
          "userNotificationEnabled": true
        }
      ],
      "microtenantId": 0,
      "microtenantName": "string"
    }
  ],
  "totalCount": 0,
  "totalPages": 0
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/praConsole

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
page
integer($int32)
(query)
Specifies the page number.
Example : 1
pagesize
integer($int32)
(query)
Specifies the page size. If not provided, the default page size is 20. The max page size is 500.
Example : 20
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
search
string
(query)
The search string used to support search by features and fields for the API.

list
The total list of privileged consoles.

creationTime
integer($int32)
The time the privileged console is created.
description
string
The description of the privileged console.
enabled
boolean
Whether or not the privileged console is enabled.
iconText
string
The privileged console icon. The icon image is converted to base64 encoded text format.
id
integer($int64)
The unique identifier of the privileged console
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The tenant who modified the privileged console.
modifiedTime
integer($int32)
The time the privileged console is modified.
name*
string
The name of the privileged console.
praApplication

appId
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
applicationPort
integer($int32)
The port of the Privileged Remote Access-enabled application.
applicationProtocol
string
The protocol of the Privileged Remote Access-enabled application.
[
...
]
8 items
connectionSecurity
string
The connection security mechanism used when connecting to remote machines.
[
...
]
6 items
creationTime
integer($int32)
The time the Privileged Remote Access-enabled application is created.
description
string
The description of the Privileged Remote Access-enabled application.
domain
string
The domain of the Privileged Remote Access-enabled application.
enabled
boolean
Whether or not the PRA application is enabled.
hidden
boolean
id
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the Privileged Remote Access-enabled application.
modifiedTime
integer($int32)
The time the Privileged Remote Access-enabled application is modified.
name*
string
The name of the Privileged Remote Access-enabled application.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
praPortals

cName
string
The canonical name (CNAME DNS records) associated with the privileged portal.
certificateId
integer($int64)
The unique identifier of the certificate.
certificateName
string
The name of the certificate.
creationTime
integer($int32)
The time the privileged portal is created.
description
string
The description of the privileged portal.
domain
string
The domain of the privileged portal.
enabled
boolean
Whether or not the privileged portal is enabled.
id
integer($int64)
The unique identifier of the privileged portal.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged portal.
modifiedTime
integer($int32)
The time the privileged portal is modified.
name*
string
The name of the privileged portal.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
userNotification
string
The notification message displayed in the banner of the privileged portallink, if enabled.
userNotificationEnabled
boolean
Indicates if the Notification Banner is enabled (true) or disabled (false).
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
totalCount
integer($int64)
The total count of resources per the search feature.
totalPages
integer($int32)
The total number of pages per the pagination attribute.
Responses
Response content type:
Code
200
Description
OK
Example Value
{
  "list": [
    {
      "creationTime": 0,
      "description": "string",
      "enabled": true,
      "iconText": "string",
      "id": 0,
      "inconsistentConfigDetails": {
        "application": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "segmentGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "appConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "baCertificate": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "branchConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "cloudConnectorGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "idp": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "location": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "machineGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "postureProfile": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "samlAttributes": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "scimAttributes": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "serverGroup": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "praApplication": [
          {
            "name": "string",
            "reason": "string"
          }
        ],
        "trustedNetwork": [
          {
            "name": "string",
            "reason": "string"
          }
        ]
      },
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "praApplication": {
        "appId": 0,
        "applicationPort": 0,
        "applicationProtocol": "HTTP",
        "connectionSecurity": "ANY",
        "creationTime": 0,
        "description": "string",
        "domain": "string",
        "enabled": true,
        "hidden": true,
        "id": 0,
        "modifiedBy": 0,
        "modifiedTime": 0,
        "name": "string",
        "microtenantId": 0,
        "microtenantName": "string"
      },
      "praPortals": [
        {
          "cName": "string",
          "certificateId": 0,
          "certificateName": "string",
          "creationTime": 0,
          "description": "string",
          "domain": "string",
          "enabled": true,
          "id": 0,
          "modifiedBy": 0,
          "modifiedTime": 0,
          "name": "string",
          "microtenantId": 0,
          "microtenantName": "string",
          "userNotification": "string",
          "userNotificationEnabled": true
        }
      ],
      "microtenantId": 0,
      "microtenantName": "string"
    }
  ],
  "totalCount": 0,
  "totalPages": 0
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/praConsole

Parameters

Name
Description
console *required
object
(body)
The object of the privileged console.
{
  "creationTime": 0,
  "description": "string",
  "enabled": true,
  "iconText": "string",
  "id": 0,
  "inconsistentConfigDetails": {
    "application": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "segmentGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "appConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "baCertificate": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "branchConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "cloudConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "idp": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "location": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "machineGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "postureProfile": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "samlAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "scimAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "serverGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "praApplication": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "trustedNetwork": [
      {
        "name": "string",
        "reason": "string"
      }
    ]
  },
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "praApplication": {
    "appId": 0,
    "applicationPort": 0,
    "applicationProtocol": "HTTP",
    "connectionSecurity": "ANY",
    "creationTime": 0,
    "description": "string",
    "domain": "string",
    "enabled": true,
    "hidden": true,
    "id": 0,
    "modifiedBy": 0,
    "modifiedTime": 0,
    "name": "string",
    "microtenantId": 0,
    "microtenantName": "string"
  },
  "praPortals": [
    {
      "cName": "string",
      "certificateId": 0,
      "certificateName": "string",
      "creationTime": 0,
      "description": "string",
      "domain": "string",
      "enabled": true,
      "id": 0,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "microtenantId": 0,
      "microtenantName": "string",
      "userNotification": "string",
      "userNotificationEnabled": true
    }
  ],
  "microtenantId": 0,
  "microtenantName": "string"
}

creationTime
integer($int32)
The time the privileged console is created.
description
string
The description of the privileged console.
enabled
boolean
Whether or not the privileged console is enabled.
iconText
string
The privileged console icon. The icon image is converted to base64 encoded text format.
id
integer($int64)
The unique identifier of the privileged console
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The tenant who modified the privileged console.
modifiedTime
integer($int32)
The time the privileged console is modified.
name*
string
The name of the privileged console.
praApplication

appId
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
applicationPort
integer($int32)
The port of the Privileged Remote Access-enabled application.
applicationProtocol
string
The protocol of the Privileged Remote Access-enabled application.
[
...
]
8 items
connectionSecurity
string
The connection security mechanism used when connecting to remote machines.
[
...
]
6 items
creationTime
integer($int32)
The time the Privileged Remote Access-enabled application is created.
description
string
The description of the Privileged Remote Access-enabled application.
domain
string
The domain of the Privileged Remote Access-enabled application.
enabled
boolean
Whether or not the PRA application is enabled.
hidden
boolean
id
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the Privileged Remote Access-enabled application.
modifiedTime
integer($int32)
The time the Privileged Remote Access-enabled application is modified.
name*
string
The name of the Privileged Remote Access-enabled application.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
praPortals

cName
string
The canonical name (CNAME DNS records) associated with the privileged portal.
certificateId
integer($int64)
The unique identifier of the certificate.
certificateName
string
The name of the certificate.
creationTime
integer($int32)
The time the privileged portal is created.
description
string
The description of the privileged portal.
domain
string
The domain of the privileged portal.
enabled
boolean
Whether or not the privileged portal is enabled.
id
integer($int64)
The unique identifier of the privileged portal.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged portal.
modifiedTime
integer($int32)
The time the privileged portal is modified.
name*
string
The name of the privileged portal.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
userNotification
string
The notification message displayed in the banner of the privileged portallink, if enabled.
userNotificationEnabled
boolean
Indicates if the Notification Banner is enabled (true) or disabled (false).
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.

Parameters content type:

customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.

creationTime
integer($int32)
The time the privileged console is created.
description
string
The description of the privileged console.
enabled
boolean
Whether or not the privileged console is enabled.
iconText
string
The privileged console icon. The icon image is converted to base64 encoded text format.
id
integer($int64)
The unique identifier of the privileged console
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The tenant who modified the privileged console.
modifiedTime
integer($int32)
The time the privileged console is modified.
name*
string
The name of the privileged console.
praApplication

appId
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
applicationPort
integer($int32)
The port of the Privileged Remote Access-enabled application.
applicationProtocol
string
The protocol of the Privileged Remote Access-enabled application.
[
...
]
8 items
connectionSecurity
string
The connection security mechanism used when connecting to remote machines.
[
...
]
6 items
creationTime
integer($int32)
The time the Privileged Remote Access-enabled application is created.
description
string
The description of the Privileged Remote Access-enabled application.
domain
string
The domain of the Privileged Remote Access-enabled application.
enabled
boolean
Whether or not the PRA application is enabled.
hidden
boolean
id
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the Privileged Remote Access-enabled application.
modifiedTime
integer($int32)
The time the Privileged Remote Access-enabled application is modified.
name*
string
The name of the Privileged Remote Access-enabled application.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
praPortals

cName
string
The canonical name (CNAME DNS records) associated with the privileged portal.
certificateId
integer($int64)
The unique identifier of the certificate.
certificateName
string
The name of the certificate.
creationTime
integer($int32)
The time the privileged portal is created.
description
string
The description of the privileged portal.
domain
string
The domain of the privileged portal.
enabled
boolean
Whether or not the privileged portal is enabled.
id
integer($int64)
The unique identifier of the privileged portal.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged portal.
modifiedTime
integer($int32)
The time the privileged portal is modified.
name*
string
The name of the privileged portal.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
userNotification
string
The notification message displayed in the banner of the privileged portallink, if enabled.
userNotificationEnabled
boolean
Indicates if the Notification Banner is enabled (true) or disabled (false).
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
Responses
Response content type:
Code
201
Description
Created
Example Value
{
  "creationTime": 0,
  "description": "string",
  "enabled": true,
  "iconText": "string",
  "id": 0,
  "inconsistentConfigDetails": {
    "application": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "segmentGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "appConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "baCertificate": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "branchConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "cloudConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "idp": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "location": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "machineGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "postureProfile": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "samlAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "scimAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "serverGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "praApplication": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "trustedNetwork": [
      {
        "name": "string",
        "reason": "string"
      }
    ]
  },
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "praApplication": {
    "appId": 0,
    "applicationPort": 0,
    "applicationProtocol": "HTTP",
    "connectionSecurity": "ANY",
    "creationTime": 0,
    "description": "string",
    "domain": "string",
    "enabled": true,
    "hidden": true,
    "id": 0,
    "modifiedBy": 0,
    "modifiedTime": 0,
    "name": "string",
    "microtenantId": 0,
    "microtenantName": "string"
  },
  "praPortals": [
    {
      "cName": "string",
      "certificateId": 0,
      "certificateName": "string",
      "creationTime": 0,
      "description": "string",
      "domain": "string",
      "enabled": true,
      "id": 0,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "microtenantId": 0,
      "microtenantName": "string",
      "userNotification": "string",
      "userNotificationEnabled": true
    }
  ],
  "microtenantId": 0,
  "microtenantName": "string"
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/praConsole/{id}

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
id *required
integer($int64)
(path)
The unique identifier of the privileged console.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.

creationTime
integer($int32)
The time the privileged console is created.
description
string
The description of the privileged console.
enabled
boolean
Whether or not the privileged console is enabled.
iconText
string
The privileged console icon. The icon image is converted to base64 encoded text format.
id
integer($int64)
The unique identifier of the privileged console
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The tenant who modified the privileged console.
modifiedTime
integer($int32)
The time the privileged console is modified.
name*
string
The name of the privileged console.
praApplication

appId
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
applicationPort
integer($int32)
The port of the Privileged Remote Access-enabled application.
applicationProtocol
string
The protocol of the Privileged Remote Access-enabled application.
[
...
]
8 items
connectionSecurity
string
The connection security mechanism used when connecting to remote machines.
[
...
]
6 items
creationTime
integer($int32)
The time the Privileged Remote Access-enabled application is created.
description
string
The description of the Privileged Remote Access-enabled application.
domain
string
The domain of the Privileged Remote Access-enabled application.
enabled
boolean
Whether or not the PRA application is enabled.
hidden
boolean
id
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the Privileged Remote Access-enabled application.
modifiedTime
integer($int32)
The time the Privileged Remote Access-enabled application is modified.
name*
string
The name of the Privileged Remote Access-enabled application.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
praPortals

cName
string
The canonical name (CNAME DNS records) associated with the privileged portal.
certificateId
integer($int64)
The unique identifier of the certificate.
certificateName
string
The name of the certificate.
creationTime
integer($int32)
The time the privileged portal is created.
description
string
The description of the privileged portal.
domain
string
The domain of the privileged portal.
enabled
boolean
Whether or not the privileged portal is enabled.
id
integer($int64)
The unique identifier of the privileged portal.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged portal.
modifiedTime
integer($int32)
The time the privileged portal is modified.
name*
string
The name of the privileged portal.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
userNotification
string
The notification message displayed in the banner of the privileged portallink, if enabled.
userNotificationEnabled
boolean
Indicates if the Notification Banner is enabled (true) or disabled (false).
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
Responses
Response content type:
Code
200
Description
OK
Example Value
{
  "creationTime": 0,
  "description": "string",
  "enabled": true,
  "iconText": "string",
  "id": 0,
  "inconsistentConfigDetails": {
    "application": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "segmentGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "appConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "baCertificate": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "branchConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "cloudConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "idp": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "location": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "machineGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "postureProfile": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "samlAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "scimAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "serverGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "praApplication": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "trustedNetwork": [
      {
        "name": "string",
        "reason": "string"
      }
    ]
  },
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "praApplication": {
    "appId": 0,
    "applicationPort": 0,
    "applicationProtocol": "HTTP",
    "connectionSecurity": "ANY",
    "creationTime": 0,
    "description": "string",
    "domain": "string",
    "enabled": true,
    "hidden": true,
    "id": 0,
    "modifiedBy": 0,
    "modifiedTime": 0,
    "name": "string",
    "microtenantId": 0,
    "microtenantName": "string"
  },
  "praPortals": [
    {
      "cName": "string",
      "certificateId": 0,
      "certificateName": "string",
      "creationTime": 0,
      "description": "string",
      "domain": "string",
      "enabled": true,
      "id": 0,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "microtenantId": 0,
      "microtenantName": "string",
      "userNotification": "string",
      "userNotificationEnabled": true
    }
  ],
  "microtenantId": 0,
  "microtenantName": "string"
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/praConsole/{id}

Parameters

Name
Description
console *required
object
(body)
The object of the privileged console.

Parameters content type:

customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
id *required
integer($int64)
(path)
The unique identifier of the privileged console.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
Responses
Response content type:
Code
201
Description
Created
Code
204
Description
No Content
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/praConsole/{id}

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
id *required
integer($int64)
(path)
The unique identifier of the privileged console.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
Responses
Response content type:
Code
204
Description
No Content
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
/mgmtconfig/v1/admin/customers/{customerId}/praConsole/bulk

Parameters

Name
Description
consoles *required
array[undefined]
(body)
The objects of the privileged console.
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
microtenantId
integer($int64)
(query)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.

creationTime
integer($int32)
The time the privileged console is created.
description
string
The description of the privileged console.
enabled
boolean
Whether or not the privileged console is enabled.
iconText
string
The privileged console icon. The icon image is converted to base64 encoded text format.
id
integer($int64)
The unique identifier of the privileged console
inconsistentConfigDetails

application

name
string
reason
string
segmentGroup

name
string
reason
string
appConnectorGroup

name
string
reason
string
baCertificate

name
string
reason
string
branchConnectorGroup

name
string
reason
string
cloudConnectorGroup

name
string
reason
string
idp

name
string
reason
string
location

name
string
reason
string
machineGroup

name
string
reason
string
postureProfile

name
string
reason
string
samlAttributes

name
string
reason
string
scimAttributes

name
string
reason
string
serverGroup

name
string
reason
string
praApplication

name
string
reason
string
trustedNetwork

name
string
reason
string
modifiedBy
integer($int64)
The tenant who modified the privileged console.
modifiedTime
integer($int32)
The time the privileged console is modified.
name*
string
The name of the privileged console.
praApplication

appId
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
applicationPort
integer($int32)
The port of the Privileged Remote Access-enabled application.
applicationProtocol
string
The protocol of the Privileged Remote Access-enabled application.
[
...
]
8 items
connectionSecurity
string
The connection security mechanism used when connecting to remote machines.
[
...
]
6 items
creationTime
integer($int32)
The time the Privileged Remote Access-enabled application is created.
description
string
The description of the Privileged Remote Access-enabled application.
domain
string
The domain of the Privileged Remote Access-enabled application.
enabled
boolean
Whether or not the PRA application is enabled.
hidden
boolean
id
integer($int64)
The unique identifier of the Privileged Remote Access-enabled application.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the Privileged Remote Access-enabled application.
modifiedTime
integer($int32)
The time the Privileged Remote Access-enabled application is modified.
name*
string
The name of the Privileged Remote Access-enabled application.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
praPortals

cName
string
The canonical name (CNAME DNS records) associated with the privileged portal.
certificateId
integer($int64)
The unique identifier of the certificate.
certificateName
string
The name of the certificate.
creationTime
integer($int32)
The time the privileged portal is created.
description
string
The description of the privileged portal.
domain
string
The domain of the privileged portal.
enabled
boolean
Whether or not the privileged portal is enabled.
id
integer($int64)
The unique identifier of the privileged portal.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the privileged portal.
modifiedTime
integer($int32)
The time the privileged portal is modified.
name*
string
The name of the privileged portal.
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
userNotification
string
The notification message displayed in the banner of the privileged portallink, if enabled.
userNotificationEnabled
boolean
Indicates if the Notification Banner is enabled (true) or disabled (false).
microtenantId
integer($int64)
The unique identifier of the Microtenant for the ZPA tenant. If you are within the Default Microtenant, pass microtenantId as 0 when making requests to retrieve data from the Default Microtenant. Pass microtenantId as null to retrieve data from all customers associated with the tenant.
microtenantName
string
The name of the Microtenant.
Responses
Response content type:
Code
201
Description
Created
Example Value
{
  "creationTime": 0,
  "description": "string",
  "enabled": true,
  "iconText": "string",
  "id": 0,
  "inconsistentConfigDetails": {
    "application": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "segmentGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "appConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "baCertificate": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "branchConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "cloudConnectorGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "idp": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "location": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "machineGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "postureProfile": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "samlAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "scimAttributes": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "serverGroup": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "praApplication": [
      {
        "name": "string",
        "reason": "string"
      }
    ],
    "trustedNetwork": [
      {
        "name": "string",
        "reason": "string"
      }
    ]
  },
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "praApplication": {
    "appId": 0,
    "applicationPort": 0,
    "applicationProtocol": "HTTP",
    "connectionSecurity": "ANY",
    "creationTime": 0,
    "description": "string",
    "domain": "string",
    "enabled": true,
    "hidden": true,
    "id": 0,
    "modifiedBy": 0,
    "modifiedTime": 0,
    "name": "string",
    "microtenantId": 0,
    "microtenantName": "string"
  },
  "praPortals": [
    {
      "cName": "string",
      "certificateId": 0,
      "certificateName": "string",
      "creationTime": 0,
      "description": "string",
      "domain": "string",
      "enabled": true,
      "id": 0,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "microtenantId": 0,
      "microtenantName": "string",
      "userNotification": "string",
      "userNotificationEnabled": true
    }
  ],
  "microtenantId": 0,
  "microtenantName": "string"
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found