Versions Compared

Old Version 7

changes.mady.by.user Edward Charles Delaporte

Saved on

compared with

New Version Current

changes.mady.by.user trscavo@internet2.edu

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

SSL Certificate API

The

Basics

Technologies

The Comodo APIs can be accessed with a SOAP client.

The SSL Certificate API supports enrolling new certificate requests, renewing existing certificates and collecting certificates. See the SSL Certificate API documentation for additional details.

API Documents

SMIME Enroll API

See http://www.incommon.org/cert/repository/InCommon_CM_SMIME_Enroll_API.pdf

Reporting API

Allows the Administrator to get Activity Log Report, Client Certificates Report, SSL Certificates Report, Discovery Scan Log Report, Discovery Scan Detail Report and the Latest Discovery Scan Log Report.

See https://support.comodo.com/index.php?_m=downloads&_a=viewdownload&downloaditemid=113

Note: The Reporting API is only available for use by MRAOs.

Technology

The Comodo APIs may be accessed with a SOAP client. For example, see the demo python client contributed by Jason Phelps from the University of Texas or the C# sample client contributed by Gabriel Sroka from the California State University system.

Support

Email support for the API is available at cmapi@comodo.com, Monday through Friday, 4 AM - 8 PM Eastern Time. See the Certificate Service support page for a detailed listing of all support options. You may need to also copy your request to csmsupport@comodo.com; see 'Known Issues' below.

Documentation

PDF documentation for the SSL Certificate API and the Client Certificate API are linked on the repository page. Comodo also provides online API documentation.

Frequently Asked Questions

Finding OrgId

Q: In section 2.3 of http:The InCommon API documentation is linked in the last section of this page: https://www.incommon.org/cert/repository/index.html

When you have problems

InCommon_CM_SSL_Web_Service_API.pdf
it says that I need the "orgId" in order to use the enrollment SOAP call. How do I find the orgId for our institution? The instructions in the above document say "Can be obtained from Admin UI - Organization properties "SSL Cert" tab", but this was not much help: I could not see the organization id anywhere in our certificate manager.

A: Go to Settings - Orgs, click Departments. Select the department to provision through, click edit, go to SSL tab, enable the web API check box and assign a secret key. The orgId will appear next to the secret key text box.

Status Codes

The SSL and Client APIs share a common set of status codes. If you stumble onto an undocumented status code or error condition, please file a bug with Comodo. It would benefit other API users if you also documented your experiences here on this wiki page.

TODO: Add a link to the Bug tracking system.

...

Basic information about the possible error codes is provided in the Comodo API documentation ; but some of the error codes can have multiple causes. Additional anecdotal details are may be provided here as a community reference.

  • -

...

  • 14 = An unknown error occurred!

...

  • Check that the login_uri customerLoginUri parameter of your authData object is set to 'InCommon'.
  • -32 = The two phrase should be the same!

...

  • Check your revocation phrase ('phrase' parameter). It appears that it cannot be left as empty string.

Questions

Known Issues

  • As of 4/18 cmapi@comodo.com does not yet issue a support ticket when emailed. csmsupport@comodo.com have been helpful in answering questions in the meantime

...

  • .

Community

To join the InCommon certificate  community discussion (which has included discussion of how to best leverage Certificate API's), consider joining the InCommon certificate mailing list: inc-cert@incommon.org

Bug Tracking

If you get an error not covered in the API Documentation (see [https://www.incommon.org/cert/repository/index.htmlImage Removed|https://www.incommon.org/cert/repository/index.html]), please submit a bug report.

InCommon maintains an email list, cert-users@incommon.org, as a place for community members to share experiences, discuss possible system enhancements, and see how other campuses handle various issues and tasks. We encourage you to join this list. To do so, send an email to sympa@incommon.org with the following in the subject line: sub cert-users FirstName LastName.

Attachments

...