Page History

Purpose

A set of API functions allows you to manage devices cards (USB 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:

• Get smart cards
• Revoke smart cards
• Disable smart cards
• Enable smart cards
• Update smart cards

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

1. Cards - get the list of cards added to the system1. GetCards - get a list of user's smart cards.

Request type:

• • GET

Parameter:

Parameters:

• • without parameters
  • offset - shift by the specified number of cards
  • count - number of output cards
  • filter.serialNumber -  card serial number
  • filter.userName - user logon name in sAMAccountName or userPrincipalName format
  • 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
    – TracedCertificatesExpiredName - username in UPN format (user principal name)

Return values (CardInfo object list):

• • id -  smart card identifier
  • serialNumber -  smart 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)atr - ATR smart cards
  • label - smart card label
  • comment - comment for card
  • tags - card tags
  • state - smart card state
  • formFactor - card form factor
  • pacNumber - smart card HID label
  • expirationDate - card expiration date in ISO 8601 format
  • timeIssued - сard issue time in ISO 8601 format
  • timeDisabled - card disable time in ISO 8601 format
  • timeUpdated - card update time in ISO 8601 format
  • timeRevoked - card revocation time in ISO 8601 format

2. Cards/{id}/2. Revoke - withdraw user card.

Request type:

• • POST

Parameters:

• • id -  smart card identifier

  • reason - smart card revoke revocation reason:

    – 0 - noneNone
    – 1 - broken CardBroken
    – 2 - lostCardLost
    – 3 - upgradeCardUpgrade
    – 4 - expiredCardExpired
    – 5 - withdrawCardWithdraw
    – 6 - user removedUserRemoved
    – 7 - CardCompromised

Return values:

• • not

Request body:

• • Smart card revoke Card revocation reason - for example, { "reason": 5 "CardWithdraw" }

3. Cards/{id}/Disable - temporarily disable the user's smart card.

Request type:

• • POST

Parameter:

• • id -  smart card identifier

Return values:

• • not

4. Cards/{id}/Enable - enable the user's smart card.

Request type:

• • POST

Parameter:

• • id -  smart card identifier

Return values:

• • not

5. PreupdateCards/{id}/PreUpdate - revoke irrelevant user certificate.

Request type:

• • POST

Parameter:

• • id -   smart card identifier

Return values:

• • not