You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Purpose

A set of API functions allows you to manage cards (tokens, smart cards) by means of client applications.

Usage

Access to API functions is implemented through the icmapi web application, which is part of the Indeed Certificate Manager server. To interact with Indeed CM through the API, in the Roles section of the Indeed CM configuration, you will need to create a service role, include the account on whose behalf the API will be accessed, and define privileges for the role:

  • Finding users
  • Viewing card repository
  • Enabling card
  • Disabling card
  • Updating card
  • Revoking card

1. GetCards - get the list of user's cards.

Request type:

    • GET

Parameter:

    • name - username in UPN format (user principal name)

Return values (CardInfo object list):

    • id - card identifier
    • serialNumber - card serial number
    • cardTypeName - card type name
    • cardModelName - card model name is available only for eToken PRO Java 72K and IDPrime MD cards if a division for different models is added in the Card types section for these cards
    • atr - card ATR (Answer To Reset)
    • label - card label
    • comment - comment for card
    • tags - card tags
    • state - card state
    • formFactor - card form factor
    • pacNumber - card HID label
    • expirationDate - card expiration date

Example:

http://localhost/icmapi/user/getcards?name=mike.benson@demo.local

2. GetAllCards - get the list of cards added to the system.

Request type:

    • GET

Parameters:

    • without parameters
    • offset - shift by the specified number of cards
    • count - number of output cards
    • filter.serialNumber -  card serial number
    • filter.cardTypeName - cards type
    • filter.comment - comment for cards
    • filter.tags - card tags
    • filter.state - card state:
      – Clean
      – Assigned
      – Pending
      – Issued
      – Disabled
      – Revoked
    • filter.contentExpirationStatus - content expiration status:
      – None 
      – ManagedCertificatesExpiring 
      – ManagedCertificatesExpired 
      – CommonCertificatesExpiring
      – CommonCertificatesExpired
      – TracedCertificatesExpiring
      – TracedCertificatesExpired

Return values (CardInfo object list):

    • id - card identifier
    • serialNumber - card serial number
    • cardTypeName - card type name
    • cardModelName - card model name is available only for eToken PRO Java 72K and IDPrime MD cards if a division for different models is added in the Card types section for these cards
    • atr - card ATR (Answer To Reset)
    • label - card label
    • comment - comment for card
    • tags - card tags
    • state - card state
    • formFactor - card form factor
    • pacNumber - card HID label
    • expirationDate - card expiration date

Example:

http://localhost/icmapi/Card/GetAllCards - output of all cards
http://localhost/icmapi/Card/GetAllCards?offset=0&count=50 - output of 50 cards without shifting

3. Revoke - withdraw user card.

Request type:

    • POST

Parameters:

    • id - card identifier

    • reason - card revocation reason:

      – 0 - none
      – 1 - broken
      – 2 - lost
      – 3 - upgrade
      – 4 - expired
      – 5 - withdraw
      – 6 - user removed

      – 7 - compromised

Return values:

    • not

Example:

http://localhost/icmapi/card/revoke?id=id1

Request body:

    • Card revoke reason - for example, { reason: 5 }

4. Disable - temporarily disable the user's card.

Request type:

    • POST

Parameter:

    • id - card identifier

Return values:

    • not

Example:

http://localhost/icmapi/card/disable?id=id1

5. Enable - enable the user's card.

Request type:

    • POST

Parameter:

    • id - card identifier

Return values:

    • not

Example:

http://localhost/icmapi/card/enable?id=id1

6. Preupdate - revoke irrelevant user certificate.

The Preupdate method is required when changing smart card usage policy. If the issued certificate is not supported in the new policy, it will be deleted.

The Preupdate method cannot be performed on a smart card that is disabled, assigned, revoked, and pending issue or update.

Request type:

    • POST

Parameter:

    • id - card identifier

Return values:

    • not

Example:

http://localhost/icmapi/card/preupdate?id=id1


  • No labels