/mgmtconfig/v2/admin/customers/{customerId}/enrollmentCert

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
search
string
(query)
The search string used to support search by features and fields for the API.

list
The total list of enrollment certificates.

allowSigning
boolean
This field is extracted from the certificate and ignored in PUT and POST requests.
cName
string
The canonical name of the enrollment certificate. This field is extracted from the certificate and ignored in PUT and POST requests.
certificate*
string
The certificate text in PEM format.
clientCertType
string
The client of the enrollment certificate. This field has read-only properties, is only applicable for GET requests, and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the enrollment certificate is created.
csr
string
The Certificate Signing Request (CSR) of the enrollment certificate.
description
string
The description of the enrollment certificate.
id
integer($int64)
The unique identifier of the enrollment certificate.
issuedBy
string
The unique identifier of the tenant the enrollment certificate is issued by.
issuedTo
string
The unique identifier of the tenant the enrollment certificate is issued to.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the enrollment certificate.
modifiedTime
integer($int32)
The time the enrollment certificate is modified.
name
string
The name of the enrollment certificate.
parentCertId
integer($int64)
The unique identifier of the parent certificate. This field has read-only properties, is only applicable for GET requests, and is ignored in PUT and POST requests.
parentCertName
string
The name of the parent certificate. This field has read-only properties, is only applicable for GET requests, and is ignored in PUT and POST requests.
privateKey
string
The private key of the enrollment certificate.
privateKeyPresent
boolean
Indicates if the private key is present in the enrollment certificate. This field has read-only properties, is only applicable for GET requests, and is ignored in PUT and POST requests.
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.
serialNo
string
The serial number of the enrollment certificate.
validFromInEpochSec
integer($int64)
The start date of the enrollment certificate. This field is extracted from the certificate and is not applicable for PUT and POST requests.
validToInEpochSec
integer($int64)
The expiration date of the enrollment certificate. This field is extracted from the certificate and is not applicable for PUT and POST requests.
zrsaencryptedprivatekey
string
The RSA encrypted private key.
zrsaencryptedsessionkey
string
The RSA encrypted session key.
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": [
    {
      "allowSigning": true,
      "cName": "string",
      "certificate": "string",
      "clientCertType": "ZAPP_CLIENT",
      "creationTime": 0,
      "csr": "string",
      "description": "string",
      "id": 0,
      "issuedBy": "string",
      "issuedTo": "string",
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "parentCertId": 0,
      "parentCertName": "string",
      "privateKey": "string",
      "privateKeyPresent": true,
      "microtenantId": 0,
      "serialNo": "string",
      "validFromInEpochSec": 0,
      "validToInEpochSec": 0,
      "zrsaencryptedprivatekey": "string",
      "zrsaencryptedsessionkey": "string"
    }
  ],
  "totalCount": 0,
  "totalPages": 0
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found
/mgmtconfig/v1/admin/customers/{customerId}/enrollmentCert/{enrollmentCertId}

Parameters

Name
Description
customerId *required
integer($int64)
(path)
The unique identifier of the ZPA tenant.
enrollmentCertId *required
integer($int64)
(path)
The unique identifier of the enrollment certificate.

allowSigning
boolean
This field is extracted from the certificate and ignored in PUT and POST requests.
cName
string
The canonical name of the enrollment certificate. This field is extracted from the certificate and ignored in PUT and POST requests.
certificate*
string
The certificate text in PEM format.
clientCertType
string
The client of the enrollment certificate. This field has read-only properties, is only applicable for GET requests, and is ignored in PUT and POST requests.
[
...
]
3 items
creationTime
integer($int32)
The time the enrollment certificate is created.
csr
string
The Certificate Signing Request (CSR) of the enrollment certificate.
description
string
The description of the enrollment certificate.
id
integer($int64)
The unique identifier of the enrollment certificate.
issuedBy
string
The unique identifier of the tenant the enrollment certificate is issued by.
issuedTo
string
The unique identifier of the tenant the enrollment certificate is issued to.
modifiedBy
integer($int64)
The unique identifier of the tenant who modified the enrollment certificate.
modifiedTime
integer($int32)
The time the enrollment certificate is modified.
name
string
The name of the enrollment certificate.
parentCertId
integer($int64)
The unique identifier of the parent certificate. This field has read-only properties, is only applicable for GET requests, and is ignored in PUT and POST requests.
parentCertName
string
The name of the parent certificate. This field has read-only properties, is only applicable for GET requests, and is ignored in PUT and POST requests.
privateKey
string
The private key of the enrollment certificate.
privateKeyPresent
boolean
Indicates if the private key is present in the enrollment certificate. This field has read-only properties, is only applicable for GET requests, and is ignored in PUT and POST requests.
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.
serialNo
string
The serial number of the enrollment certificate.
validFromInEpochSec
integer($int64)
The start date of the enrollment certificate. This field is extracted from the certificate and is not applicable for PUT and POST requests.
validToInEpochSec
integer($int64)
The expiration date of the enrollment certificate. This field is extracted from the certificate and is not applicable for PUT and POST requests.
zrsaencryptedprivatekey
string
The RSA encrypted private key.
zrsaencryptedsessionkey
string
The RSA encrypted session key.
Responses
Response content type:
Code
200
Description
OK
Example Value
{
  "allowSigning": true,
  "cName": "string",
  "certificate": "string",
  "clientCertType": "ZAPP_CLIENT",
  "creationTime": 0,
  "csr": "string",
  "description": "string",
  "id": 0,
  "issuedBy": "string",
  "issuedTo": "string",
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "parentCertId": 0,
  "parentCertName": "string",
  "privateKey": "string",
  "privateKeyPresent": true,
  "microtenantId": 0,
  "serialNo": "string",
  "validFromInEpochSec": 0,
  "validToInEpochSec": 0,
  "zrsaencryptedprivatekey": "string",
  "zrsaencryptedsessionkey": "string"
}
Code
401
Description
Unauthorized
Code
403
Description
Forbidden
Code
404
Description
Not Found