Certificate Management APIs

Use the following APIs to create, update and delete certificates.

Generate a CA Certificate

Required Permissions

You must have CREATE_CERTIFICATE permissions to perform this operation.

API

/api​/certificates​/generate

Method

POST

Required Parameters

None

Input Example of Generate a Self-Signed CA Certificate

{
  "certificateType": "CA",
  "displayName": "Test-CA",
  "validity": 365,
  "countryName": "US",
  "stateOrProvinceName": "CA",
  "localityName": "Palo Alto",
  "organizationName": "VMWare Inc.",
  "organizationalUnitName": "R&D",
  "emailAddress": "[email protected]",
  "commonName": "Test-CA"
}

Note: The output of generate CA certificate is a certificate ID. This must be passed into caCertificateID field in generate entity certificate and generate entity certificate from CSR request.

Input Example of Generate Entity Certificate

{
  "certificateType": "ENTITY",
  "displayName": "Entity1",
  "validity": 90,
  "countryName": "US",
  "stateOrProvinceName": "CA",
  "localityName": "Palo Alto",
  "organizationName": "VMWare Inc.",
  "organizationalUnitName": "R&D",
  "emailAddress": "[email protected]",
  "commonName": "Entity1",
  "caCertificateId": "84fee0ac-65fd-4b3d-aa36-917582cfc4f1"
}

Input Example of Generate Entity Certificate from CSR

{
  "certificateType": "ENTITY",
  "displayName": "Entity1",
  "validity": 90,
  "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICuDCCAaACAQAwczELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRIwEAYDVQQH\nDAlQYWxvIEFsdG8xFDASBgNVBAoMC1ZNd2FyZSBJbmMuMS0wKwYDVQQDDCRhMGM4\nN2QxMy05Mjg2LTRiMDQtOWFlMy1jMDBhN2E4YzgxMGIwggEiMA0GCSqGSIb3DQEB\nAQUAA4IBDwAwggEKAoIBAQDtS3iA2+nynRiZVgPOKxphMPLwcE9p8yMO2IqImevd\nG6hCtINqNw/jAgxF/Ja0SvYLzStvl0E+pY6wVq8xD0OWoo9cpwVSAVaoq2wcA/VM\nTaU7OQtLaoRbPXgYCTE3okFaZsQ+xtFAyPFEvnOD5dItAhKEpYv0noKxPyTeBmIq\naOAGBtEpCk7uwRtgPLm6JfoDBI2LK54hAbsS0kHOkOMX6Cg2fu1+9CnVNZIFYf76\nsKS+lT5fLitgfPlB7lJZCmVWriZMybD3IA4EwiTG0UDUQ08LAhdAw0nWKAAyGIuK\nRJ+WjHPFpt0MWZ8i3265Iftns0u293gau7+Z9hjUQ3qNAgMBAAGgADANBgkqhkiG\n9w0BAQsFAAOCAQEAoinoPp0V1n2iFc4z3WvvSotUhTKeRpTvpkifgyLbcFcRPkM0\nPpZVlUVypDwk+zpm2MqRogJu+7iN6xsF7RQreXXAQUw4P8xNiySS4fMie0hMjpri\nHGWVA7EsjadabvmBCwCoeWhd+hs0dp2VCDHRZh2yYrKpgJcQephkKGH+sjUkR2kd\n354U4bNa9gIrGers7z7KNcFIOOfc6VuLIG+th4sJkTCDQ386gLzmfF8bhsiOro6z\nlxEaUWdU1QXZJqJYDfpCPb37nyJb4tN/qJGaGvjuU20ivhroIcFNp2fSfKuvQ294\nb6eVxYLKwtrZQcaJ5RwZ9D0tutqtQgngmekJRA==\n-----END CERTIFICATE REQUEST-----\n",
  "caCertificateId": "84fee0ac-65fd-4b3d-aa36-917582cfc4f1"

Response

{
  "id": "84fee0ac-65fd-4b3d-aa36-917582cfc4f1"
}

Register an External CA Certificate

Required Permissions

You must have the CREATE_CERTIFICATE permission to perform this operation.

API

/api​/certificates

Method

POST

Required Parameters

None

Sample Request for Register CA Certificate

{
  "certificateType": "CA",
  "displayName": "TestCA",
  "certificate": "-----BEGIN CERTIFICATE-----
\nMIIEAzCCAuugAwIBAgIJAO3/xKDSEL0PMA0GCSqGSIb3DQEBCwUAMF4xCzAJBgNV\nBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRIwEAYDVQQHDAlQYWxvIEFsdG8x\nETAPBgNVBAoMCFZNVy1UZXN0MRMwEQYDVQQDDApUZXN0Q0FDZXJ0MB4XDTE5MDky\nOTA5NTU0MVoXDTIwMDkyODA5NTU0MVowXjELMAkGA1UEBhMCVVMxEzARBgNVBAgM\nCkNhbGlmb3JuaWExEjAQBgNVBAcMCVBhbG8gQWx0bzERMA8GA1UECgwIVk1XLVRl\nc3QxEzARBgNVBAMMClRlc3RDQUNlcnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQDfhlnvJ+/cyYEqtkVbnNx0wXiDEYf5cNpvbHCTHWja+JEZg8P3f5VB\nQIF8HX65BVVnE3f7nXPSdN+/BTUPh7qsnwyH5HcnnUOvMlaida2yKUfKC8ZJYCVv\nxNTUk7TWfTWeMSVY++/HfcfQzHQ8PRtU8LqjEdvsLHcAEZJO+4fTVUTYikGeIeRj\n66OEEpK69l2NK11VJ0mXezw1wFDMP318kUZqWdtJIWKBkXMrSIrL9aJQlrYxo63A\nbJlM3UGrGxQl1wKcVBpXF9RQ6t0pEqYxXIG876b0LyvHRH2Ktmth1nCDrrKzq0LY\nz5Lv7k6PdZEkQ4PeMS2NGRBJnbWmOA2PAgMBAAGjgcMwgcAwHQYDVR0OBBYEFHo9\nVCfLM9PTZyape/pY14Nut/BLMIGQBgNVHSMEgYgwgYWAFHo9VCfLM9PTZyape/pY\n14Nut/BLoWKkYDBeMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTES\nMBAGA1UEBwwJUGFsbyBBbHRvMREwDwYDVQQKDAhWTVctVGVzdDETMBEGA1UEAwwK\nVGVzdENBQ2VydIIJAO3/xKDSEL0PMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEL\nBQADggEBAK4UrP7kiU8dmOVgQw2dKcBeZS4vgbcLtJm7R+BgmMGLVlz5RSWyUGN3\n2VqpgUVgTGO4wXMxpn/K9+SKSRN4L2UexwsMZ6PpCbhYataLsb5WEPaVBC4Aue8k\njQvz1QYNQBmtVf0JQd2S5edEj3b7D5wxgsLNgpkcScb/yK7rf0TGgARd4uj2jIXu\nWLc1QgW2DDrz9+qfud9X3mi9+x1gero2+j65FJ//F8t9UU2GzJWIvJZIE74YP+gS\nQZAFMQjIYHdz+lEyEhaIrvs2Hn4ux8dQnHEYVOqMNIPpmFiIE+QmZm8q5MnH9lu1\noos2FYWcpDfazh9oqtsc5Uf+5BHTFpQ=\n
-----END CERTIFICATE-----\n",
  "privateKeyVerificationCertificate": "-----BEGIN CERTIFICATE-----\nMIIDKTCCAhECCQC/8PN1bxg4ezANBgkqhkiG9w0BAQsFADBeMQswCQYDVQQGEwJV\nUzETMBEGA1UECAwKQ2FsaWZvcm5pYTESMBAGA1UEBwwJUGFsbyBBbHRvMREwDwYD\nVQQKDAhWTVctVGVzdDETMBEGA1UEAwwKVGVzdENBQ2VydDAeFw0xOTA5MjkwOTU4\nMTRaFw0yMDA5MjgwOTU4MTRaME8xCzAJBgNVBAYTAlVTMREwDwYDVQQKDAhWTVct\nVGVzdDEtMCsGA1UEAwwkYTBjODdkMTMtOTI4Ni00YjA0LTlhZTMtYzAwYTdhOGM4\nMTBiMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlff5HOpU738EsErQ\nxmEldKAB2FjHIIS0s4fGZixBSR5R+RpPpfSbnyGPsIhYZqqWr+nUW/TWUrSONeFt\nP14/FAtzHbZcnNAru9ODrTLMTJEsmxFU1NhcFmKIXbnaEuLLdL1o/h4pwpej3w6c\nQbHv7kym1m/11aHxa4Btnp9lgNN0Qjx161wC325CO6C4yw+mmoOa35PhqxMEF5Aa\nSUU6IqK9pl70zM0IASjbkPcbLkQYhjNpjzxk5jeeYSHIgoor0YlxdGPzj/EYzwSV\nb35UoAM/A6TaamOsm2XHktht5QHsNnlWFfBMfS+kb33p/XbX7vyFrr9enEjPuPYn\njV50gwIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQBf36PeazgEgZf09h3xgNpwZEBB\n79ypJf8BItsro7oscblvxsuIgGxeYEyxE2ce7U/zlPKZNIWtdYZIpp95C976vhHy\n6ObpJRaIwjACvGkOzZvZ2CpoVENyoAEWfdeOvz1SVkekjdRz6jBOvzfpKmyA1DW5\n2naiTvwVNasRMPgGZPVDOBqGQOzW64xnk/EYEt3uqxY3/iL3jcIOOwFRyj6lzKan\nqaDUIvaf6vGtIHFpuWNZq5D3VJwzmtdqZ7+oEavVW2JRv+fXA8xKVDQclVZ4qcuZ\ncghLCt2aVDP7lpuePtBooTgQjl2fBahOlDc8MCm2Sz08bAwmfq2fbXfPM2Vv\n-----END CERTIFICATE-----\n",
  "state": "ACTIVE"
}

Sample Request for Register Entity Certificate

{
  "certificateType": "ENTITY",
  "displayName": "TestDevice1Cert",
  "certificate": "-----BEGIN CERTIFICATE-----\nMIIDEjCCAfoCCQC/8PN1bxg4fDANBgkqhkiG9w0BAQsFADBeMQswCQYDVQQGEwJV\nUzETMBEGA1UECAwKQ2FsaWZvcm5pYTESMBAGA1UEBwwJUGFsbyBBbHRvMREwDwYD\nVQQKDAhWTVctVGVzdDETMBEGA1UEAwwKVGVzdENBQ2VydDAeFw0xOTA5MjkwOTU5\nMzVaFw0xOTEyMjgwOTU5MzVaMDgxCzAJBgNVBAYTAlVTMRAwDgYDVQQKDAdWTVct\nVGVzMRcwFQYDVQQDDA5kZXZpY2UxLXJhbmRvbTCCASIwDQYJKoZIhvcNAQEBBQAD\nggEPADCCAQoCggEBAKn+UYn9bIFH0kDZ9dzJ2EHzrqqALrbW2j5ZFNvksYWLLG71\nB5ifBeGV7m+UAbXzpmZfNm9injGHi9Y9Y0pJfJYYxLNIUdE/U1K6NBk5HbJJUCy/\n6KX9aB7PA7N4h2d9YrQCDLOc7rlJBEaQkaRx+Hbm1jZis2poZTENJgxmdP4eGmQS\n2xoV++IzXdXdS2Bo//sOWXcSvVlWFQoLHfVvHOXuQnCXNnpRKsllZ161EQxF4HC8\n78Yd51EDqVp7jTmO8m4jZHYAavZPL+T3Xuz2U76ykj42ykWs6PU9hRPf4ehyMgo6\nkidErMplwx1yUszO9vfYUwmHBl7LPX4pajDIt/kCAwEAATANBgkqhkiG9w0BAQsF\nAAOCAQEAuHfQqohJI9NPr/km320g0PeVY3U9NZkbGzgt5G9sznnaLTzQCe9YxM+z\nc5lhloTdL6Us7J7Z5VT3t3f5CRGHyuQTHYgnE/inML1OKRc/5UlKznbdPfwOLsTg\njPZ9KoP5F260CO1SCEKY448dNtMxsOehYO6GpsgB6RgInjYrbz40fklhw/Vz5ubg\nbebyy84c/abDcKaxDsQUSgc8boWBVnVRG9gtiL6ifP18NbWjluwTsysOn6tHs0oS\nMIApJXaJi2+PJ7jp729cm2MFpwSKKZc272dDJEOqa7GPjXtJ/8sg+2n3YrZjGq8x\nAviQmnfUT8kwqeGefM3xHWYnF0SWPQ==\n-----END CERTIFICATE-----\n",
  "caCertificateId": "261f5328-0822-47ce-85ce-c0a797b9911b",
  "state": "ACTIVE"
}

Response

"id": "7df0d3ad-01c9-4d16-a39c-96ca8c0e0625"

List the Certificates

Required Permissions

You must have the VIEW_CERTIFICATE permission to perform this operation.

API

/api​/certificates

Method

GET

Required Parameters

Parameters	Values
queryType	SHOW_CURRENT, SHOW_DESCENDANTS, SHOW_ANCESTORS, SHOW_ALL
state	ACTIVE, REVOKED, EXPIRED
name	CA, ENTITY
caCertificateId	DEVICE
entityId	If true, returns all entity certificates currently not assigned to any entity. If false, returns all entity certificates assigned to any entity.

Sample Request

Response

{
  "certificates": [
    {
      "displayName": "TestDevice1Cert",
      "state": "ACTIVE",
      "certificate": "-----BEGIN CERTIFICATE-----\nMIIEAzCCAuugAwIBAgIJAO3/xKDSEL0PMA0GCSqGSIb3DQEBCwUAMF4xCzAJBgNV\nBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRIwEAYDVQQHDAlQYWxvIEFsdG8x\nETAPBgNVBAoMCFZNVy1UZXN0MRMwEQYDVQQDDApUZXN0Q0FDZXJ0MB4XDTE5MDky\nOTA5NTU0MVoXDTIwMDkyODA5NTU0MVowXjELMAkGA1UEBhMCVVMxEzARBgNVBAgM\nCkNhbGlmb3JuaWExEjAQBgNVBAcMCVBhbG8gQWx0bzERMA8GA1UECgwIVk1XLVRl\nc3QxEzARBgNVBAMMClRlc3RDQUNlcnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQDfhlnvJ+/cyYEqtkVbnNx0wXiDEYf5cNpvbHCTHWja+JEZg8P3f5VB\nQIF8HX65BVVnE3f7nXPSdN+/BTUPh7qsnwyH5HcnnUOvMlaida2yKUfKC8ZJYCVv\nxNTUk7TWfTWeMSVY++/HfcfQzHQ8PRtU8LqjEdvsLHcAEZJO+4fTVUTYikGeIeRj\n66OEEpK69l2NK11VJ0mXezw1wFDMP318kUZqWdtJIWKBkXMrSIrL9aJQlrYxo63A\nbJlM3UGrGxQl1wKcVBpXF9RQ6t0pEqYxXIG876b0LyvHRH2Ktmth1nCDrrKzq0LY\nz5Lv7k6PdZEkQ4PeMS2NGRBJnbWmOA2PAgMBAAGjgcMwgcAwHQYDVR0OBBYEFHo9\nVCfLM9PTZyape/pY14Nut/BLMIGQBgNVHSMEgYgwgYWAFHo9VCfLM9PTZyape/pY\n14Nut/BLoWKkYDBeMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTES\nMBAGA1UEBwwJUGFsbyBBbHRvMREwDwYDVQQKDAhWTVctVGVzdDETMBEGA1UEAwwK\nVGVzdENBQ2VydIIJAO3/xKDSEL0PMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEL\nBQADggEBAK4UrP7kiU8dmOVgQw2dKcBeZS4vgbcLtJm7R+BgmMGLVlz5RSWyUGN3\n2VqpgUVgTGO4wXMxpn/K9+SKSRN4L2UexwsMZ6PpCbhYataLsb5WEPaVBC4Aue8k\njQvz1QYNQBmtVf0JQd2S5edEj3b7D5wxgsLNgpkcScb/yK7rf0TGgARd4uj2jIXu\nWLc1QgW2DDrz9+qfud9X3mi9+x1gero2+j65FJ//F8t9UU2GzJWIvJZIE74YP+gS\nQZAFMQjIYHdz+lEyEhaIrvs2Hn4ux8dQnHEYVOqMNIPpmFiIE+QmZm8q5MnH9lu1\noos2FYWcpDfazh9oqtsc5Uf+5BHTFpQ=\n-----END CERTIFICATE-----\n",
      "providerType": "UNKNOWN",
      "subjectDN": "CN=TestDevice1Cert, O=VMW-Test, L=Palo Alto, ST=California, C=US",
      "issuerDN": "CN=TestDevice1Cert, O=VMW-Test, L=Palo Alto, ST=California, C=US",
      "validFrom": 1569751175000,
      "validTill": 1577527175000,
      "serialNumber": "17149642101048261903",
      "isRootCA": false,
      "isCaCert": false,
      "entityType": null,
      "entityId": null,
      "caCertificateId": "f2010f44-5200-48ca-bbcc-0f82d19341d0",
      "additionalProperties": {},
      "orgId": "a0c87d13-9286-4b04-9ae3-c00a7a8c810b",
      "createdTime": 1569751434413,
      "lastUpdatedTime": 1569751434413,
      "updateVersion": 1,
      "createdBy": "40c3608a-3d7c-47f8-aa57-b8c799c8c971",
      "lastUpdatedBy": "40c3608a-3d7c-47f8-aa57-b8c799c8c971",
      "id": "0415f537-1d00-4353-97e3-ce4cb1124c78"
    },
    {
      "displayName": "TestCACert",
      "state": "ACTIVE",
      "certificate": "-----BEGIN CERTIFICATE-----\nMIIEAzCCAuugAwIBAgIJAO3/xKDSEL0PMA0GCSqGSIb3DQEBCwUAMF4xCzAJBgNV\nBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRIwEAYDVQQHDAlQYWxvIEFsdG8x\nETAPBgNVBAoMCFZNVy1UZXN0MRMwEQYDVQQDDApUZXN0Q0FDZXJ0MB4XDTE5MDky\nOTA5NTU0MVoXDTIwMDkyODA5NTU0MVowXjELMAkGA1UEBhMCVVMxEzARBgNVBAgM\nCkNhbGlmb3JuaWExEjAQBgNVBAcMCVBhbG8gQWx0bzERMA8GA1UECgwIVk1XLVRl\nc3QxEzARBgNVBAMMClRlc3RDQUNlcnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQDfhlnvJ+/cyYEqtkVbnNx0wXiDEYf5cNpvbHCTHWja+JEZg8P3f5VB\nQIF8HX65BVVnE3f7nXPSdN+/BTUPh7qsnwyH5HcnnUOvMlaida2yKUfKC8ZJYCVv\nxNTUk7TWfTWeMSVY++/HfcfQzHQ8PRtU8LqjEdvsLHcAEZJO+4fTVUTYikGeIeRj\n66OEEpK69l2NK11VJ0mXezw1wFDMP318kUZqWdtJIWKBkXMrSIrL9aJQlrYxo63A\nbJlM3UGrGxQl1wKcVBpXF9RQ6t0pEqYxXIG876b0LyvHRH2Ktmth1nCDrrKzq0LY\nz5Lv7k6PdZEkQ4PeMS2NGRBJnbWmOA2PAgMBAAGjgcMwgcAwHQYDVR0OBBYEFHo9\nVCfLM9PTZyape/pY14Nut/BLMIGQBgNVHSMEgYgwgYWAFHo9VCfLM9PTZyape/pY\n14Nut/BLoWKkYDBeMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTES\nMBAGA1UEBwwJUGFsbyBBbHRvMREwDwYDVQQKDAhWTVctVGVzdDETMBEGA1UEAwwK\nVGVzdENBQ2VydIIJAO3/xKDSEL0PMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEL\nBQADggEBAK4UrP7kiU8dmOVgQw2dKcBeZS4vgbcLtJm7R+BgmMGLVlz5RSWyUGN3\n2VqpgUVgTGO4wXMxpn/K9+SKSRN4L2UexwsMZ6PpCbhYataLsb5WEPaVBC4Aue8k\njQvz1QYNQBmtVf0JQd2S5edEj3b7D5wxgsLNgpkcScb/yK7rf0TGgARd4uj2jIXu\nWLc1QgW2DDrz9+qfud9X3mi9+x1gero2+j65FJ//F8t9UU2GzJWIvJZIE74YP+gS\nQZAFMQjIYHdz+lEyEhaIrvs2Hn4ux8dQnHEYVOqMNIPpmFiIE+QmZm8q5MnH9lu1\noos2FYWcpDfazh9oqtsc5Uf+5BHTFpQ=\n-----END CERTIFICATE-----\n",
      "providerType": "UNKNOWN",
      "subjectDN": "CN=TestCACert, O=VMW-Test, L=Palo Alto, ST=California, C=US",
      "issuerDN": "CN=TestCACert, O=VMW-Test, L=Palo Alto, ST=California, C=US",
      "validFrom": 1569750941000,
      "validTill": 1601286941000,
      "serialNumber": "121496423451048261287",
      "isRootCA": true,
      "isCaCert": true,
      "entityType": null,
      "entityId": null,
      "caCertificateId": null,
      "additionalProperties": {},
      "orgId": "a0c87d13-9286-4b04-9ae3-c00a7a8c810b",
      "createdTime": 1569751336660,
      "lastUpdatedTime": 1569751336660,
      "updateVersion": 1,
      "createdBy": "40c3608a-3d7c-47f8-aa57-b8c799c8c971",
      "lastUpdatedBy": "40c3608a-3d7c-47f8-aa57-b8c799c8c971",
      "id": "f2010f44-5200-48ca-bbcc-0f82d19341d0"
    }
  ],
  "pageInfo": {
    "totalPages": 1,
    "page": 1,
    "pageSize": 10,
    "totalElements": 2
  }
}

Assign a Certificate to an Entity

Required Permissions

You must have the DEVICE_ADMIN permission to perform this operation.

API

/api​/certificates​/{id}​/assign

Method

POST

Required Parameters

Parameters	Values
id string	Certificate identifier

Sample Request

{
  "entityType": "DEVICE",
  "entityId": "1fa595a5-c851-4447-ba34-74a6057c5d00"
}

Response

"id": "75ase0ac-65fd-4b3d-aa36-917582cfcff7"

Unassign a Certificate

Required Permissions

You must have the DEVICE_ADMIN permission to perform this operation.

API

/api​/certificates​/{id}​/assign

Method

POST

Required Parameters

Parameters	Values
id string	Certificate identifier

Sample Request

Response

{
  "id": "75ase0ac-65fd-4b3d-aa36-917582cfcff7"
}

List the Certificate With the Given Id

Required Permissions

You must have the VIEW_CERTIFICATE permission to perform this operation.

API

/api​/certificates​/{id}

Method

GET

Required Parameters

Parameters	Values
id string	Certificate identifier

Sample Request

Response

{
  "displayName": "TestCACert",
  "state": "ACTIVE",
  "certificate": "-----BEGIN CERTIFICATE-----\nMIIEAzCCAuugAwIBAgIJAO3/xKDSEL0PMA0GCSqGSIb3DQEBCwUAMF4xCzAJBgNV\nBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRIwEAYDVQQHDAlQYWxvIEFsdG8x\nETAPBgNVBAoMCFZNVy1UZXN0MRMwEQYDVQQDDApUZXN0Q0FDZXJ0MB4XDTE5MDky\nOTA5NTU0MVoXDTIwMDkyODA5NTU0MVowXjELMAkGA1UEBhMCVVMxEzARBgNVBAgM\nCkNhbGlmb3JuaWExEjAQBgNVBAcMCVBhbG8gQWx0bzERMA8GA1UECgwIVk1XLVRl\nc3QxEzARBgNVBAMMClRlc3RDQUNlcnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQDfhlnvJ+/cyYEqtkVbnNx0wXiDEYf5cNpvbHCTHWja+JEZg8P3f5VB\nQIF8HX65BVVnE3f7nXPSdN+/BTUPh7qsnwyH5HcnnUOvMlaida2yKUfKC8ZJYCVv\nxNTUk7TWfTWeMSVY++/HfcfQzHQ8PRtU8LqjEdvsLHcAEZJO+4fTVUTYikGeIeRj\n66OEEpK69l2NK11VJ0mXezw1wFDMP318kUZqWdtJIWKBkXMrSIrL9aJQlrYxo63A\nbJlM3UGrGxQl1wKcVBpXF9RQ6t0pEqYxXIG876b0LyvHRH2Ktmth1nCDrrKzq0LY\nz5Lv7k6PdZEkQ4PeMS2NGRBJnbWmOA2PAgMBAAGjgcMwgcAwHQYDVR0OBBYEFHo9\nVCfLM9PTZyape/pY14Nut/BLMIGQBgNVHSMEgYgwgYWAFHo9VCfLM9PTZyape/pY\n14Nut/BLoWKkYDBeMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTES\nMBAGA1UEBwwJUGFsbyBBbHRvMREwDwYDVQQKDAhWTVctVGVzdDETMBEGA1UEAwwK\nVGVzdENBQ2VydIIJAO3/xKDSEL0PMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEL\nBQADggEBAK4UrP7kiU8dmOVgQw2dKcBeZS4vgbcLtJm7R+BgmMGLVlz5RSWyUGN3\n2VqpgUVgTGO4wXMxpn/K9+SKSRN4L2UexwsMZ6PpCbhYataLsb5WEPaVBC4Aue8k\njQvz1QYNQBmtVf0JQd2S5edEj3b7D5wxgsLNgpkcScb/yK7rf0TGgARd4uj2jIXu\nWLc1QgW2DDrz9+qfud9X3mi9+x1gero2+j65FJ//F8t9UU2GzJWIvJZIE74YP+gS\nQZAFMQjIYHdz+lEyEhaIrvs2Hn4ux8dQnHEYVOqMNIPpmFiIE+QmZm8q5MnH9lu1\noos2FYWcpDfazh9oqtsc5Uf+5BHTFpQ=\n-----END CERTIFICATE-----\n",
  "providerType": "UNKNOWN",
  "subjectDN": "CN=TestCACert, O=VMW-Test, L=Palo Alto, ST=California, C=US",
  "issuerDN": "CN=TestCACert, O=VMW-Test, L=Palo Alto, ST=California, C=US",
  "validFrom": 1569750941000,
  "validTill": 1601286941000,
  "serialNumber": "17149642101048261903",
  "isCaCert": true,
  "isRootCA": true,
  "entityType": null,
  "entityId": null,
  "caCertificateId": null,
  "additionalProperties": {},
  "orgId": "a0c87d13-9286-4b04-9ae3-c00a7a8c810b",
  "createdTime": 1569751336660,
  "lastUpdatedTime": 1569751336660,
  "updateVersion": 1,
  "createdBy": "40c3608a-3d7c-47f8-aa57-b8c799c8c971",
  "lastUpdatedBy": "40c3608a-3d7c-47f8-aa57-b8c799c8c971",
  "id": "f2010f44-5200-48ca-bbcc-0f82d19341d0"
}

Delete a Certificate

Required Permissions

You must have the DELETE_CERTIFICATE permission to perform this operation.

API

/api​/certificates​/{id}

Method

DELETE

Required Parameters

Parameters	Values
id string	Certificate identifier

Sample Request

Response

Update a Certificate

Required Permissions

You must have the EDIT_CERTIFICATE permission to perform this operation.

API

/api​/certificates​/{id}

Method

PUT

Required Parameters

Parameters	Values
id string	Certificate identifier

Sample Request

{
  "displayName": "TestDevice1Cert",
  "certificate": "-----BEGIN CERTIFICATE-----\nMIIDEjCCAfoCCQC/8PN1bxg4fDANBgkqhkiG9w0BAQsFADBeMQswCQYDVQQGEwJV\nUzETMBEGA1UECAwKQ2FsaWZvcm5pYTESMBAGA1UEBwwJUGFsbyBBbHRvMREwDwYD\nVQQKDAhWTVctVGVzdDETMBEGA1UEAwwKVGVzdENBQ2VydDAeFw0xOTA5MjkwOTU5\nMzVaFw0xOTEyMjgwOTU5MzVaMDgxCzAJBgNVBAYTAlVTMRAwDgYDVQQKDAdWTVct\nVGVzMRcwFQYDVQQDDA5kZXZpY2UxLXJhbmRvbTCCASIwDQYJKoZIhvcNAQEBBQAD\nggEPADCCAQoCggEBAKn+UYn9bIFH0kDZ9dzJ2EHzrqqALrbW2j5ZFNvksYWLLG71\nB5ifBeGV7m+UAbXzpmZfNm9injGHi9Y9Y0pJfJYYxLNIUdE/U1K6NBk5HbJJUCy/\n6KX9aB7PA7N4h2d9YrQCDLOc7rlJBEaQkaRx+Hbm1jZis2poZTENJgxmdP4eGmQS\n2xoV++IzXdXdS2Bo//sOWXcSvVlWFQoLHfVvHOXuQnCXNnpRKsllZ161EQxF4HC8\n78Yd51EDqVp7jTmO8m4jZHYAavZPL+T3Xuz2U76ykj42ykWs6PU9hRPf4ehyMgo6\nkidErMplwx1yUszO9vfYUwmHBl7LPX4pajDIt/kCAwEAATANBgkqhkiG9w0BAQsF\nAAOCAQEAuHfQqohJI9NPr/km320g0PeVY3U9NZkbGzgt5G9sznnaLTzQCe9YxM+z\nc5lhloTdL6Us7J7Z5VT3t3f5CRGHyuQTHYgnE/inML1OKRc/5UlKznbdPfwOLsTg\njPZ9KoP5F260CO1SCEKY448dNtMxsOehYO6GpsgB6RgInjYrbz40fklhw/Vz5ubg\nbebyy84c/abDcKaxDsQUSgc8boWBVnVRG9gtiL6ifP18NbWjluwTsysOn6tHs0oS\nMIApJXaJi2+PJ7jp729cm2MFpwSKKZc272dDJEOqa7GPjXtJ/8sg+2n3YrZjGq8x\nAviQmnfUT8kwqeGefM3xHWYnF0SWPQ==\n-----END CERTIFICATE-----\n",
  "caCertificateId": "261f5328-0822-47ce-85ce-c0a797b9911b",
  "state": "ACTIVE"
}

Response

{
  "id": "75ase0ac-65fd-4b3d-aa36-917582cfcff7"
}