Overview of REST API

ActivID CMS is a highly extensible card and credential management platform. It provides the tools, documentation, and APIs needed to enable system integrators and technology partners to:

  • Extend ActivID CMS functionality,

  • Support additional credential providers, such as Private Key Infrastructure (PKI) Certificate Authorities (CAs),

  • Customize data handling for personalization/production of smart cards and USB security devices, and

  • Leverage ActivID CMS functionality from external systems (such as Card and Credential Request Management and Card Issuance, Operator Management, etc.)

These tools and API are provided by the CCM Card and Credential Management API. For details, refer to About the CCM API.

The first version of the REST API provided only one service: Operator management. The second version (new in ActivID CMS 5.10) provides new services that focus on device issuance and termination.

The remainder of this document details the REST API services:

  • The OAuth 2.0 API to manage operator authentication with PKI

  • The SCIM (System for Cross-domain Identity Management) API to:

    • Create, search, and delete operators.

    • Search and update devices.

    • Search device policies.

    • Create, search, update, and delete content requests.

Note: The ActivID CMS REST API is the successor of the CCM API. It is not yet complete; the CCM API can still be used. For more information, see About the CCM API.

Topics in this section: