Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Purpose
A set of API functions allows you to manage devices 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
- Get smart cards
- Revoke smart cards
- Disable smart cards
- Enable smart cards
- Update smart cards
1. GetCards - get a list of user's smart cards.
Request type:
- GET
Parameter:
- Name name - username in UPN format (user principal name)
Return values (CardInfo object list):
- id - smart card identifier
- serialNumber - smart card serial number
- atr - ATR smart cardscard ATR (Answer To Reset)
- label - smart card label
- state - smart card state
- formFactor - card form factor
- pacNumber - smart card HID label
- expirationDate - card expiration date
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/user/getcards?name=user1mike.benson@demo.local |
2. GetAllCards - get a 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
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
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/Card/GetAllCards - output of all cards |
32. Revoke - withdraw user card.
Request type:
- POST
Parameters:
- id - smart card identifier
reason - smart card revoke reason:
– 0 - none
– 7 - compromised
– 1 - broken
– 2 - lost
– 3 - upgrade
– 4 - expired
– 5 - withdraw
– 6 - user removed
Return values:
- not
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/card/revoke?id=id1 |
Request body:
- Smart card Card revoke reason - for example, { reason: 5 }
34. Disable - temporarily disable the user's smart card.
Request type:
- POST
Parameter:
- id - smart card identifier
Return values:
- not
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/card/disable?id=id1 |
45. Enable - enable the user's smart card.
Request type:
- POST
Parameter:
- id - smart card identifier
Return values:
- not
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/card/enable?id=id1 |
56. Preupdate - revoke irrelevant user certificate.
| Warning |
|---|
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 - smart card identifier
Return values:
- not
| Info | ||||
|---|---|---|---|---|
| ||||
http://localhost/icmapi/card/preupdate?id=id1 |