Skip to main content

SmartCredential

Information returned from the service about a smart credential.

Properties

NameTypeDescriptionNotes
allowedActionsList<AllowedActionsEnum>A list of administration actions currently allowed for this smart credential.[optional]
cardDigitalConfigDigitalIdConfig[optional]
cardDigitalConfigIdStringThe UUID of the Card Digital Id config of this smart credential. If not set, the smart credential will not have a Card Digital Id.[optional]
cardDigitalConfigRequiredBooleanIndicates if the card digitalid config is required or not.[optional]
cardHolderDigitalConfigDigitalIdConfig[optional]
cardHolderDigitalConfigIdStringThe UUID of the Card Holder Digital Id config of this smart credential. If not set, the smart credential will not have a Card Holder Digital Id.[optional]
cardHolderDigitalConfigRequiredBooleanIndicates if the card holder digitalid config is required or not.[optional]
certificatesList<DigitalIdCert>A list of certificates associated with this smart credential.[optional]
chipIdStringThe chip id of the smart card set when the smart credential is encoded.[optional]
digitalIdsList<DigitalId>A list of digital ids associated with this smart credential.[optional]
encodeMsgStringFor smart credentials that have failed to encode, the encode message stores a message providing information about the failure.[optional]
encodeStateEncodeStateEnumThe encode state of a smart credential indicates if encoding has started, completed successfully or failed.[optional]
enrollStateEnrollStateEnumThe enrollment state of a smart credential indicates if all of the necessary enrollment values have been collected. Only smart credentials in the ENROLLED state can be activated.[optional]
expiryDateOffsetDateTimeFor issued smart credentials, the expiry date is the date on which the smart credential will expire.[optional]
idStringThe unique UUID assigned to the smart credential when it is created.[optional]
issueDateOffsetDateTimeThe date on which the smart credential was issued.[optional]
notifyEnabledBooleanA flag indicating if notification is enabled for this smart credential.[optional]
platformStringThe platform of the Mobile SC application on which this smart credential was encoded.[optional]
scDefnIdStringThe UUID of the Smart Credential Definition that defines this smart credential.[optional]
scDefnNameStringThe name of the smart credential definition of this smart credential.[optional]
serialNumberStringThe unique serial number of the smart credential generated when it is created.[optional]
stateStateEnumThe state of the smart credential. Only smart credentials in the ACTIVE state can be used for authentication.[optional]
userIdStringThe UUID of the user that owns this smart credential.[optional]
userUserIdStringThe user Id of the user that owns this smart credential.[optional]
variableValuesList<SCVariableValue>Variable values for this smart credential[optional]
versionStringThe version of the Mobile SC application on which this smart credential was encoded.[optional]

List<AllowedActionsEnum>

NameValue
ACTIVATE"ACTIVATE"
REACTIVATE"REACTIVATE"
UPDATE"UPDATE"
UNASSIGN"UNASSIGN"
UNBLOCK"UNBLOCK"
ENABLE"ENABLE"
DISABLE"DISABLE"
DELETE"DELETE"
VIEW_CERTIFICATES"VIEW_CERTIFICATES"

EncodeStateEnum

NameValue
START"ENCODE_START"
DONE"ENCODE_DONE"
ERROR"ENCODE_ERROR"

EnrollStateEnum

NameValue
ENROLLING"ENROLLING"
ENROLLED"ENROLLED"

StateEnum

NameValue
ACTIVE"ACTIVE"
INACTIVE"INACTIVE"