Get certificate enrollment profile by ID

curl --request GET \
  --url https://{apiHost}/api/v1/ceps/id/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/ceps/id/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "<string>",
  "scepUrl": "<string>",
  "caCertPem": [
    "aSDinaTvuI8gbWludGxpZnk="
  ],
  "csrProfile": {
    "commonName": "<string>",
    "organization": "<string>",
    "organizationalUnit": "<string>",
    "country": "<string>",
    "state": "<string>",
    "locality": "<string>",
    "sanUri": [
      "<string>"
    ],
    "sanEmail": [
      "<string>"
    ],
    "renewPeriodPercent": 123,
    "keyType": "KEY_TYPE_UNSPECIFIED",
    "hashAlgorithm": "HASH_ALGORITHM_UNSPECIFIED"
  },
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "useControllerProxy": true,
  "secret": {
    "challengePassword": "<string>"
  },
  "encryptedSecrets": {},
  "cryptoKey": "<string>",
  "enterpriseId": "<string>",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "projectsList": [
    {
      "projectId": "<string>",
      "projectName": "<string>"
    }
  ],
  "profileInUse": true
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

Authentication · API availability · Download OpenAPI

Authorizations

Authorization

string

header

required

Bearer token for user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Path Parameters

string

required

System defined universally unique Id of the CEP profile

Query Parameters

showProjectsList

boolean

If true, include the list of projects referencing this CEP profile

Response

A successful response.

SCEP Certificate Enrollment Profile for obtaining certificates from a SCEP server

name

string

required

User-defined unique name for the profile

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

scepUrl

string

required

Full SCEP server URL including scheme, host, and path (e.g., https://ca.example.com/scep)

caCertPem

string<byte>[]

required

PEM-encoded trusted CA certificates for SCEP server validation (per RFC8894 section 2.2)

csrProfile

CSR Profile · object

required

Certificate Signing Request configuration including subject DN, SANs, and key parameters

Show child attributes

string

read-only

System-generated unique identifier (UUID)

title

string

Human-readable display title

Required string length: 3 - 256

Pattern: [a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+

description

string

Detailed description of the profile purpose

Maximum string length: 256

useControllerProxy

boolean

If true, SCEP requests are routed through the controller proxy; if false, device connects directly to SCEP server

secret

object

Write-only secret fields (challenge password). Not returned in GET responses.

Show child attributes

encryptedSecrets

object

Encrypted secret data (set by server, do not modify)

Show child attributes

cryptoKey

string

Encryption key reference (set by server, do not modify)

enterpriseId

string

read-only

Enterprise ID owning this profile

revision

ObjectRevision is used to store the user information. · object

Object revision information

Show child attributes

projectsList

ProjectReference represents a project that references a CEP profile · object[]

read-only

Projects referencing this CEP profile (populated only when showProjectsList=true)

Show child attributes

profileInUse

boolean

read-only

True if linked to at least one project, false otherwise

⌘I

Get certificate enrollment profile by ID

curl --request GET \
  --url https://{apiHost}/api/v1/ceps/id/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/ceps/id/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "<string>",
  "scepUrl": "<string>",
  "caCertPem": [
    "aSDinaTvuI8gbWludGxpZnk="
  ],
  "csrProfile": {
    "commonName": "<string>",
    "organization": "<string>",
    "organizationalUnit": "<string>",
    "country": "<string>",
    "state": "<string>",
    "locality": "<string>",
    "sanUri": [
      "<string>"
    ],
    "sanEmail": [
      "<string>"
    ],
    "renewPeriodPercent": 123,
    "keyType": "KEY_TYPE_UNSPECIFIED",
    "hashAlgorithm": "HASH_ALGORITHM_UNSPECIFIED"
  },
  "id": "<string>",
  "title": "<string>",
  "description": "<string>",
  "useControllerProxy": true,
  "secret": {
    "challengePassword": "<string>"
  },
  "encryptedSecrets": {},
  "cryptoKey": "<string>",
  "enterpriseId": "<string>",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "projectsList": [
    {
      "projectId": "<string>",
      "projectName": "<string>"
    }
  ],
  "profileInUse": true
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

API guides

API services

Get certificate enrollment profile by ID

Authorizations

Headers

Path Parameters

Query Parameters

Response