SCEP API (2.17.0)

Download OpenAPI specification:Download

ILM: info@otilm.com URL: https://www.otilm.com License: MIT License

REST API for managing SCEP Profiles in the platform

ILM Documentation

SCEP Profile Management

SCEP Profile Management API

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,
"scepUrl": "https://some-server.com/api/v1/protocols/scep/profile/pkiclient.exe",
"enableIntune": true,
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"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",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 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": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
},
"intuneTenant": "string",
"intuneApplicationId": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
}

Edit SCEP Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

SCEP Profile UUID

Request Body schema: application/json
required

description	string Description of the SCEP Profile
raProfileUuid	string RA Profile UUID
required	Array of objects (RequestAttribute) 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 (RequestAttribute) List of Custom Attributes
renewalThreshold	integer <int32> 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. Default value is half of certificate validity.
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
	object (ProtocolCertificateAssociationsRequestDto) Associations to set for certificates issued by the protocol

Responses

Request samples

Payload

Content type

application/json

{"description": "Sample description",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"issueCertificateAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"caCertificateUuid": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"renewalThreshold": 0,
"includeCaCertificate": false,
"includeCaCertificateChain": false,
"challengePassword": "string",
"enableIntune": true,
"intuneTenant": "string",
"intuneApplicationId": "string",
"intuneApplicationKey": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
}

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,
"scepUrl": "https://some-server.com/api/v1/protocols/scep/profile/pkiclient.exe",
"enableIntune": true,
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"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",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 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": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
},
"intuneTenant": "string",
"intuneApplicationId": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
}

Delete SCEP Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

SCEP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get list of SCEP Profiles

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Responses

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,
"scepUrl": "https://some-server.com/api/v1/protocols/scep/profile/pkiclient.exe",
"enableIntune": true
}
]

Create SCEP Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

description	string Description of the SCEP Profile
raProfileUuid	string RA Profile UUID
required	Array of objects (RequestAttribute) 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 (RequestAttribute) List of Custom Attributes
renewalThreshold	integer <int32> 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. Default value is half of certificate validity.
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
	object (ProtocolCertificateAssociationsRequestDto) Associations to set for certificates issued by the protocol
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": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"caCertificateUuid": "string",
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"renewalThreshold": 0,
"includeCaCertificate": false,
"includeCaCertificateChain": false,
"challengePassword": "string",
"enableIntune": true,
"intuneTenant": "string",
"intuneApplicationId": "string",
"intuneApplicationKey": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
},
"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,
"scepUrl": "https://some-server.com/api/v1/protocols/scep/profile/pkiclient.exe",
"enableIntune": true,
"issueCertificateAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
],
"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",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 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": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
},
"intuneTenant": "string",
"intuneApplicationId": "string",
"certificateAssociations": {"ownerUuid": "2f67a69d-7a41-4726-a25d-6a964681865a",
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"customAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
}

Update RA Profile for SCEP Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string SCEP Profile UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable SCEP Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

SCEP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable SCEP Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

SCEP Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple SCEP Profiles

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

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/json
required

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",
"altPublicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"altSignatureAlgorithm": "string",
"hybridCertificate": true,
"keySize": 0,
"altKeySize": 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": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"owner": "string",
"ownerUuid": "string",
"certificateType": "X.509",
"issuerSerialNumber": "string",
"complianceStatus": "not_checked",
"issuerCertificateUuid": "string",
"privateKeyAvailability": true,
"trustedCa": true,
"archived": false
}
]

Delete multiple SCEP Profiles

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

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/json
required

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"
}
]

SCEP API (2.17.0)

SCEP Profile Management

Get details of SCEP Profile

Authorizations:

path Parameters

Responses

Response samples

Edit SCEP Profile

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete SCEP Profile

Authorizations:

path Parameters

Responses

Response samples

Get list of SCEP Profiles

Authorizations:

Responses

Response samples

Create SCEP Profile

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update RA Profile for SCEP Profile

Authorizations:

path Parameters

Responses

Response samples

Enable SCEP Profile

Authorizations:

path Parameters

Responses

Response samples

Disable SCEP Profile

Authorizations:

path Parameters

Responses

Response samples

Enable multiple SCEP Profiles

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Disable multiple SCEP Profile

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get list of certificates eligible for CA certificate of SCEP requests

Authorizations:

query Parameters

Responses

Response samples

Delete multiple SCEP Profiles

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Force delete multiple SCEP Profiles

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required