Cards

Cards API allows you to perform the following operations:

• Get a list of cards added to Axidian CertiFlow
• Find a card by ID
• Revoke a card
• Withdraw a revoked card
• Disable a card
• Enable a card
• Preupdate a user certificate

GET /Cards

GET /Cards request returns a list of cards according to the specified filters.

Request parameteres

Parameter	Description
userName	User logon name in down-level logon name format (DOMAIN\LogonName) or in User principal name (UPN) format
policyName	Card policy name
serialNumber	c
cardTypeName	Card type name
cardModelName	Card model name. The value is only displayed for eToken PRO Java 72K and IDPrime MD cards if card model settings are installed in Configuration→Card types
comment	Card notes
tags	Card tags
state	Card status: Clean, Assigned, Pending, Issued, Disabled, Revoked
contentExpirationStatus	Information about the expiration date of certificates that are associated with a card: None: No expiring or expired certificates ManagedCertificatesExpiring: Managed certificates are about to expire ManagedCertificatesExpired: Managed certificates expired CommonCertificatesExpiring: Common certificates are about to expire CommonCertificatesExpired: Common certificates expired TracedCertificatesExpiring: Traced certificates are about to expire TracedCertificatesExpired: Traced certificates expired
timeIssued	Card issue date in ISO 8601 format. Example: 2024-12-03T11:22:20.1824104Z, 2024-12-03
timeUpdated	Card update date in ISO 8601 format
timeRevoked	Card revocation date in ISO 8601 format
offset	Shift by the specified number of cards
count	Number of cards stated in the response

Response parameteres

Parameter	Description
id	Card ID
serialNumber	Card serial number
cardTypeName	Card type name
cardModelName	Card model name. The value is only displayed for eToken PRO Java 72K and IDPrime MD cards if card model settings are installed in Configuration→Card types
atr	Answer To Reset
label	Card label
comment	Card notes
tags	Tags
state	Card status
formFactor	Card form factor
pacNumber	Card PAC number
expirationDate	Card expiration date in ISO 8601 format
timeIssued	Card issue date in ISO 8601 format
timeDisabled	Card disabling date in ISO 8601 format
timeUpdated	Card update date in ISO 8601 format
timeRevoked	Card revocation date in ISO 8601 format
userId	Card owner user ID
userName	User logon name in down-level logon name format (DOMAIN\LogonName) or in User principal name (UPN) format
policyId	Card policy ID
policyName	Card policy name
certificates	type: Certificate type serialNumber: Certificate serial number thumbprint: Certificate Thumbprint subject: Common name of the Certificate Subject issuer: Common name of the Certificate Issuer validFrom: Certificate issue date in ISO 8601 format validTo: Certificate expiration date in ISO 8601 format

Request example

http://localhost/certiflow/api/Cards – show all cards  
http://localhost/certiflow/api/Cards?offset=0&count=50 – show 50 cards without a shift

GET /Cards/{id}

GET /Cards/{id} request returns data filtered by card ID.

Request parameters

id: Card ID

Request example

http://localhost/certiflow/api/Cards/1

POST /Cards/{id}/Revoke

POST /Cards/{id}/Revoke request allows you to revoke a card.

Request parameteres

Parameter	Required/Optional	Description
id	Required	Card ID
reason	Optional	Card revocation reason 0 --: Reason is not stated 1: CardBroken 2: CardLost 3: CardUpgrade 4: CardExpired 5: CardWithdraw 6: UserRemoved 7: CardCompromised

Request example

http://localhost/certiflow/api/cards/1/revoke

POST /Cards/{id}/Withdraw

POST /Cards/{id}/Withdraw allows you to withdraw a revoked card from a user. A card is not cleared when withdrawed.

You can only withdraw a card with Revoked status.

Request parameters

id: Card ID

Request example

http://localhost/certiflow/api/cards/1/withdraw

POST /Cards/{id}/Disable

POST /Cards/{id}/Disable allows you to temporarily deactivate a card.

Request parameters

id: Card ID

Request example

http://localhost/certiflow/api/cards/1/disable

POST /Cards/{id}/Enable

POST /Cards/{id}/Enable allows you to enable a card.

Request parameteres

id: Card ID

Request example

http://localhost/certiflow/api/cards/1/enable

POST /Cards/{id}/Preupdate

POST /Cards/{id}/Preupdate allows you to revoke an invalid user certificate.

Request parameteres

id: Card ID

Request example

http://localhost/certiflow/api/cards/1/preupdate

info

You can use POST /Cards/{id}/Preupdate method when you assign a new policy on a card user. The certificate is revoken automatically if it is not supported in the new policy and the Revoke certificate when card is revoked/disabled option is enabled in the certificate template in the old policy.

POST /Cards/{id}/Preupdate method cannot be performed on a card that is disabled, assigned, revoked, or pending.