Page History

Purpose

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

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

1. GetCardsCards - get the list of user's cardscards added to the system.

Request type:

• • GET

ParameterParameters:

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

Return values (CardInfo object list):

• • id - card identifier
  • serialNumber - card serial number
  • atr - card ATR (Answer To Reset)
  • label - card label
  • state - card state
  • formFactor - card form factor
  • pacNumber - card HID label
  • expirationDate - card expiration date

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

Request type:

• • GET

Parameter:

• • 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
    – TracedCertificatesExpired
  • without parameters
  • offset - shift by the specified number of cards
  • count - number of output cards

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 datedate 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

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

Request type:

• • POST

Parameters:

• • id - card identifier

  • reason - card revoke revocation reason:

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

    compromised

    CardCompromised

Return values:

• • not

Request body:

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

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

Request type:

• • POST

Parameter:

• • id - card identifier

Return values:

• • not

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

Request type:

• • POST

Parameter:

• • id - card identifier

Return values:

• • not

5. Cards/{id}/PreUpdate6. Preupdate - revoke irrelevant user certificate.

Request type:

• • POST

Parameter:

• • id - card identifier

Return values:

• • not