Page History

Date

Description

28 January 2018

Initial Release; CCM version 6.0

Method

Usage

GET

Used to retrieve a resource

POST

Used to create a new resource

Status Code

Usage

200 OK

The request completed successfully

204 No Content

An update to an existing resource has been applied successfully

400 Bad Request

The request was malformed. The response body will include an error providing further information

404 Not Found

The requested resource does not exist

Path

Type

Description

code

Number

Error code

description

String

Error message

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=UTF-8
Content-Length: 41
{"code":-16,"description":"Unknown user"}

Header Name

Description

login

Privileged User's Login Name

password

Privileged User's Password; ( if necessary )

CustomerUri

Customer URI part of the URL e.g.s. InCommon or InCommon_Test

Attribute

Type

Description

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="16d7c114-1da8-45a0-96a3-1aa208ee8c0c"><ac:plain-text-body><![CDATA[

[ ]

Array

An Array of available SSL Types

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="44570056-d8bd-44e4-a8e9-f5fa2d070ecf"><ac:plain-text-body><![CDATA[

[ ] id

String

The SSL Type unique identifier

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="a910972e-533d-47ed-b135-987733da0a66"><ac:plain-text-body><![CDATA[

[ ] name

String

The SSL Cert Type name

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ff3edb7e-bbb1-44e5-96fb-8f4b1efe0791"><ac:plain-text-body><![CDATA[

[ ] terms [ ]

Array

An array of available terms, in days, for the SSL type.

]]></ac:plain-text-body></ac:structured-macro>

$ curl 'https://cert-manager.com/api/ssl/v1/types/' -i {color}
-H 'Content-Type: application/json' {color}
-H 'login: forest.gump@university.edu' {color}
-H 'password: RollTide4Jenny' {color}
-H 'customerUri: InCommon'

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 38

\[\{"id":

,"terms":\[

Attribute

Type

Description

Constraints

orgId

Integer

Organization ID; can be found within InCommon CM on the organization's and or department's General tab.

MUST BE positive & not NULL

csr

String

Certificate Signing Request (Base-64 encoded, with or without the:
----BEGIN xxxxx----
and
----END xxxxx----
header and footer)

MUST not be empty or NULL.
Max size: 32767 characters.

SubjAltNames

String

Comma-Separated list of DNS Subject Alternative Names (SANs)

A maximum of 100 SANs.

certType

Integer

Certificate Type ID

Obtained from /ssl/types OR /ssl/types{orgId} function

numberServers

Integer

Number of Server Licenses. Required for the Wildcard products

MUST BE positive & not NULL

serverType

Integer

Server Software Identifier

MUST BE at least -1;
See Server Type table below for acceptable attribute values

term

Integer

Certificate validity period in number of days.

MUST BE positive.

comments

String

Additional Comments/Notes for Enrollment Request

A maximum of 1024 characters accepted.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="104ce33f-5e96-44ec-8844-b17375f54aeb"><ac:plain-text-body><![CDATA[

customFields []

Array

Custom fields to be applied to enrolling certificate.

MUST contain mandatory custom fields.

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cde12c47-fa33-405b-b47e-7096fd7ea4ae"><ac:plain-text-body><![CDATA[

customFields[].name

String

The name of an enabled mandatory custom field.

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="409c44a0-ecf3-4b0e-8e4c-fb7a59f7baea"><ac:plain-text-body><![CDATA[

customFields[].value

String

The value of the custom field

]]></ac:plain-text-body></ac:structured-macro>

1

AOL

2

Apache/ModSSL

3

Apache-SSL (Ben-SSL, not Stronghold)

4

C2Net Stronghold

33

Cisco 3000 Series VPN Concentrator

34

Citrix

5

Cobalt Raq

6

Covalent Server Software

7

IBM HTTP Server

8

IBM Internet Connection Server

9

iPlanet

10

Java Web Server (Javasoft / Sun)

11

Lotus Domino

12

Lotus Domino Go!

13

Microsoft IIS 1.x to 4.x

14

Microsoft IIS 5.x and later

15

Netscape Enterprise Server

16

Netscape FastTrack

17

Novell Web Server

18

Oracle

19

Quid Pro Quo

20

R3 SSL Server

21

Raven SSL

22

RedHat Linux

23

SAP Web Application Server

24

Tomcat

25

Website Professional

26

WebStar 4.x and later

27

WebTen (from Tenon)

28

Zeus Web Server

29

Ensim

30

Plesk

31

WHM/cPanel

32

H-Sphere

-1

OTHER

$ curl 'https://ccm.com/api/ssl/v1/enroll/' -i -X POST {color}
-H 'Content-Type: application/json' {color}
-H 'login: admin_customer1453' {color}
-H 'password: mLZxWzJh1+DZAPjHgnwzxaU/KVo=' {color}
-H 'customerUri: cst1453' {color}
-d

'\{"orgId":766,"csr":"-----BEGIN CERTIFICATE REQUEST-----\nMIIC4jCCAcoCAQAwdDELMAkGA1UEBhMCVUExDTALBgNVBAgTBHRlc3QxDTALBgNV\nBAcTBHRlc3QxDTALBgNVBAoTBHRlc3QxDTALBgNVBAsTBHRlc3QxEjAQBgNVBAMT\nCWNjbXFhLmNvbTEVMBMGCSqGSIb3DQEJARYGdGVzdEB0MIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEAul8SGkicOnrMjJDvgG8P2j1Ee5hY6ww+qSoe0oI2\ntvRcLBknPHMMAkxTjW9fy80wD8hyrnc+IGlQcq2R/tEMIJHRsJD603M+2FjAwlP9\n8xtiqv0hMyHO4fEt+HMyy8Q367aTBmnZCuAxJZJapfFW9wH5jGZxuX8mnrXVsBTD\n4ZBO4UFd9P4u8P0nJx80CiuDt4COSDl6Br4pNLciPVqfwj7LQ5/skwPkNCggk3/G\nxoQX/3FV7O4fC6WCxVP1uYjJVQjlD1Tf06hPNfonVfThVuP20OL3QAlnIF3lZiyY\nJ5etdFtu+BKcPNMdQDJOS/O4Zz0YJn6K2HdAXSc1YxYniwIDAQABoCkwJwYJKoZI\nhvcNAQkOMRowGDAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DANBgkqhkiG9w0BAQsF\nAAOCAQEAVJVTTELGHWoRh8JZt+kx/zO0VnibBq/D6uB405L+Ir80X48Ei9hTLB11\nAqhSBE+AbEgBhRnEIDBjiXEDcWvC532Omex721kc17ZTzowuD8lOjfQkTHbAmjIi\nnCQNFAPf0D/zpi6Eync5pi2P//Uj/Yn7oDYYli1t61EZwuQyEu4mbQ1efUnU/SOl\nAAQtDPhNwATZPmfefjM8+YuzhG70dQvmFAClcFayKM92Zx9khDd/VnLT85YzDULJ\n8iiHW8dZNblaTsUjKrc73iX2hONZIxw6B3tGCFs8mH9lZlExV7Y2er3t/lO1pdxe\nSUohEELWcttIxyWnYgxvwaWX4lfx9A\u003d\u003d\n-----END CERTIFICATE REQUEST-----","subjAltNames":"ccmqa.com","certType":500,"numberServers":0,"serverType":-1,"term":365,"comments":"test","customFields":\[\{"name":"custom field","value":"custom field value"\}\]\}'

Parameter

Description

sslId

Certificate ID; positive integer value; Minimum value = 1
Displayed in InCommon CM as 'Self Enrollment Certificate ID'

formatType

Format Type for certificate collection.
Allowed values:

• 'x509' - for X509, Base64 encoded
  
• 'x509CO' - for X509 Certificate only, Base64 encoded
  
• 'x509IO' - for X509 Intermediates/root only, Base64 encoded
  
• 'x509IOR' - for X509 Intermediates/root only Reverse, Base64 encoded
  
• 'base64' - for PKCS#7 Base64 encoded
  
• 'bin' - for PKCS#7 Bin encoded

$ curl 'https://ccm.com/api/ssl/v1/collect/582/base64' -i {color}
-H 'login: admin_customer1447' {color}
-H 'password: mLZxWzJh1+DZAPjHgnwzxaU/KVo=' {color}
-H 'customerUri: cst1447'

HTTP/1.1 200 OK
Content-Type: application/octet-stream
content-disposition: attachment; filename=test.cert

Parameter

Description

sslId

Certificate ID; positive integer value; Minimum value = 1
Displayed in InCommon CM as 'Self Enrollment Certificate ID'

Attribute

Type

Description

Constraints

reason

String

A short comment as to why the certificate needs to be revoked.

MUST NOT be empty.
Maximum characters = 512

$ curl 'https://ccm.com/api/ssl/v1/revoke/587' -i -X POST {color}
-H 'Content-Type: application/json' {color}
-H 'login: admin_customer1489' {color}
-H 'password: mLZxWzJh1+DZAPjHgnwzxaU/KVo=' {color}
-H 'customerUri: cst1489' {color}
-d '{"reason": "test"}'

HTTP/1.1 204 No Content

renewId

String

20

Returned via the enrollment API call. It is also found in every Enrollment Successful email that InCommon CM sends.

$ curl 'https://ccm.com/api/ssl/v1/renew/10' -i -X POST {color}
-H 'Content-Type: application/json' {color}
-H 'login: admin_customer1479' {color}
-H 'password: mLZxWzJh1+DZAPjHgnwzxaU/KVo=' {color}
-H 'customerUri: cst1479' {color}
-d '{"renewId": "rqSqUt19WVhzmM6-hagZ"}'

HTTP/1.1 204 No Content

sslId

Certificate ID; positive integer value; Minimum value = 1
Displayed in InCommon CM as 'Self Enrollment Certificate ID'

$ curl 'https://ccm.com/api/ssl/v1/renew/10' -i -X POST {color}
-H 'Content-Type: application/json' {color}
-H 'login: admin_customer1479' {color}
-H 'password: mLZxWzJh1+DZAPjHgnwzxaU/KVo=' {color}
-H 'customerUri: cst1479' {color}
-d '{"sslId":5150}'

sslId

Integer

Renewed certificate's identifier.

sslId

Certificate ID; positive integer value; Minimum value = 1
Displayed in InCommon CM as 'Self Enrollment Certificate ID'

csr

String

Certificate Signing Request (Base-64 encoded, with or without the:
----BEGIN xxxxx----
and
----END xxxxx----
header and footer)

MUST not be empty or NULL.
Max size: 32767 characters.

reason

String

A short comment as to why the certificate needs to be replaced (or re-issued).

MUST NOT be empty.
Maximum characters = 512

$ curl 'https://ccm.com/api/ssl/v1/replace/586' -i -X POST {color}
-H 'Content-Type: application/json' {color}
-H 'login: admin_customer1483' {color}
-H 'password: mLZxWzJh1+DZAPjHgnwzxaU/KVo=' {color}
-H 'customerUri: cst1483' {color}
-d '{"csr":"----BEGIN CERTIFICATE REQUEST---\nMIIC4jCCAcoCAQAwdDELMAkGA1UEBhMCVUExDTALBgNVBAgTBHRlc3QxDTALBgNV\nBAcTBHRlc3QxDTALBgNVBAoTBHRlc3QxDTALBgNVBAsTBHRlc3QxEjAQBgNVBAMT\nCWNjbXFhLmNvbTEVMBMGCSqGSIb3DQEJARYGdGVzdEB0MIIBIjANBgkqhkiG9w0B\nAQEFAAOCAQ8AMIIBCgKCAQEAul8SGkicOnrMjJDvgG8P2j1Ee5hY6ww+qSoe0oI2\ntvRcLBknPHMMAkxTjW9fy80wD8hyrnc+IGlQcq2R/tEMIJHRsJD603M+2FjAwlP9\n8xtiqv0hMyHO4fEt+HMyy8Q367aTBmnZCuAxJZJapfFW9wH5jGZxuX8mnrXVsBTD\n4ZBO4UFd9P4u8P0nJx80CiuDt4COSDl6Br4pNLciPVqfwj7LQ5/skwPkNCggk3/G\nxoQX/3FV7O4fC6WCxVP1uYjJVQjlD1Tf06hPNfonVfThVuP20OL3QAlnIF3lZiyY\nJ5etdFtu+BKcPNMdQDJOS/O4Zz0YJn6K2HdAXSc1YxYniwIDAQABoCkwJwYJKoZI\nhvcNAQkOMRowGDAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DANBgkqhkiG9w0BAQsF\nAAOCAQEAVJVTTELGHWoRh8JZt+kx/zO0VnibBq/D6uB405L+Ir80X48Ei9hTLB11\nAqhSBE+AbEgBhRnEIDBjiXEDcWvC532Omex721kc17ZTzowuD8lOjfQkTHbAmjIi\nnCQNFAPf0D/zpi6Eync5pi2P//Uj/Yn7oDYYli1t61EZwuQyEu4mbQ1efUnU/SOl\nAAQtDPhNwATZPmfefjM8+YuzhG70dQvmFAClcFayKM92Zx9khDd/VnLT85YzDULJ\n8iiHW8dZNblaTsUjKrc73iX2hONZIxw6B3tGCFs8mH9lZlExV7Y2er3t/lO1pdxe\nSUohEELWcttIxyWnYgxvwaWX4lfx9A\u003d\u003d\n---END CERTIFICATE REQUEST----","reason":"test"}'