CZERTAINLY SCEP API (2.14.1)
Download OpenAPI specification:Download
REST API for managing SCEP Profiles in the platform
Get details of SCEP Profile
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string SCEP Profile UUID |
Responses
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "description": "Sample description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "includeCaCertificate": true,
- "includeCaCertificateChain": true,
- "renewThreshold": "30",
- "enableIntune": true,
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "caCertificate": {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}, - "intuneTenant": "string",
- "intuneApplicationId": "string"
}Edit SCEP Profile
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string SCEP Profile UUID |
Request Body schema: application/jsonrequired
| description | string Description of the SCEP Profile |
| raProfileUuid | string RA Profile UUID |
required | Array of objects (RequestAttributeDto) List of Attributes to issue Certificate |
| caCertificateUuid required | string UUID of the Certificate to be used as CA Certificate for SCEP Requests |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| renewalThreshold | integer <int32> Default: "Half of certificate validity" Minimum expiry days to allow renewal of certificate. Empty or the value '0' will be considered as null and half life of the certificate validity will be considered for the protocol |
| includeCaCertificate | boolean Default: "False" Include CA Certificate in the SCEP Message response |
| includeCaCertificateChain | boolean Default: "False" Include CA Certificate Chain in the SCEP Message response |
| challengePassword | string Challenge Password for the SCEP Request |
| enableIntune | boolean Status of Intune |
| intuneTenant | string Intune Tenant |
| intuneApplicationId | string Intune Application ID |
| intuneApplicationKey | string Intune Application Key |
Responses
Request samples
- Payload
Content type
application/json
{- "description": "Sample description",
- "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "caCertificateUuid": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "renewalThreshold": "Half of certificate validity",
- "includeCaCertificate": "False",
- "includeCaCertificateChain": "False",
- "challengePassword": "string",
- "enableIntune": true,
- "intuneTenant": "string",
- "intuneApplicationId": "string",
- "intuneApplicationKey": "string"
}Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "description": "Sample description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "includeCaCertificate": true,
- "includeCaCertificateChain": true,
- "renewThreshold": "30",
- "enableIntune": true,
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "caCertificate": {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}, - "intuneTenant": "string",
- "intuneApplicationId": "string"
}Response samples
- 200
- 400
- 403
Content type
application/json
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "description": "Sample description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "includeCaCertificate": true,
- "includeCaCertificateChain": true,
- "renewThreshold": "30",
- "enableIntune": true
}
]Create SCEP Profile
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
| description | string Description of the SCEP Profile |
| raProfileUuid | string RA Profile UUID |
required | Array of objects (RequestAttributeDto) List of Attributes to issue Certificate |
| caCertificateUuid required | string UUID of the Certificate to be used as CA Certificate for SCEP Requests |
Array of objects (RequestAttributeDto) List of Custom Attributes | |
| renewalThreshold | integer <int32> Default: "Half of certificate validity" Minimum expiry days to allow renewal of certificate. Empty or the value '0' will be considered as null and half life of the certificate validity will be considered for the protocol |
| includeCaCertificate | boolean Default: "False" Include CA Certificate in the SCEP Message response |
| includeCaCertificateChain | boolean Default: "False" Include CA Certificate Chain in the SCEP Message response |
| challengePassword | string Challenge Password for the SCEP Request |
| enableIntune | boolean Status of Intune |
| intuneTenant | string Intune Tenant |
| intuneApplicationId | string Intune Application ID |
| intuneApplicationKey | string Intune Application Key |
| name required | string Name of the SCEP Profile |
Responses
Request samples
- Payload
Content type
application/json
{- "description": "Sample description",
- "raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "caCertificateUuid": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "renewalThreshold": "Half of certificate validity",
- "includeCaCertificate": "False",
- "includeCaCertificateChain": "False",
- "challengePassword": "string",
- "enableIntune": true,
- "intuneTenant": "string",
- "intuneApplicationId": "string",
- "intuneApplicationKey": "string",
- "name": "Profile Name 1"
}Response samples
- 201
- 400
- 403
- 404
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "description": "Sample description",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "includeCaCertificate": true,
- "includeCaCertificateChain": true,
- "renewThreshold": "30",
- "enableIntune": true,
- "issueCertificateAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "caCertificate": {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}, - "intuneTenant": "string",
- "intuneApplicationId": "string"
}Enable multiple SCEP Profiles
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
SCEP Profile UUIDs
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]Response samples
- 400
- 403
Content type
application/json
{- "message": "Error message"
}Disable multiple SCEP Profile
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
SCEP Profile UUIDs
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]Response samples
- 400
- 403
Content type
application/json
{- "message": "Error message"
}Get list of certificates eligible for CA certificate of SCEP requests
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
query Parameters
| intuneEnabled required | boolean flag to return certificates that are eligible for Intune integration |
Responses
Response samples
- 200
- 400
- 403
Content type
application/json
[- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "state": "requested",
- "validationStatus": "not_checked",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "groups": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "email": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
], - "owner": "string",
- "ownerUuid": "string",
- "certificateType": "X.509",
- "issuerSerialNumber": "string",
- "complianceStatus": "not_checked",
- "issuerCertificateUuid": "string",
- "privateKeyAvailability": true,
- "trustedCa": true
}
]Delete multiple SCEP Profiles
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
SCEP Profile UUIDs
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]Response samples
- 200
- 400
- 403
Content type
application/json
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]Force delete multiple SCEP Profiles
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
SCEP Profile UUIDs
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]Response samples
- 200
- 400
- 403
- 422
Content type
application/json
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "message": "Object is associated with other items"
}
]