Skip to main content

SCDefn

Information returned about a smart credential definition.

Properties

NameTypeDescriptionNotes
cardDigitalIdConfigRequiredBooleanA flag indicating if smart credentials using this SC definition must have a card digital id config defined.[optional]
cardHolderDigitalIdConfigRequiredBooleanA flag indicating if smart credentials using this SC definition must have a card holder digital id config defined.[optional]
cardPinDigitsCardPinDigitsEnumRequirements for digits in card PINs for smart credentials for this SC Defn.[optional]
cardPinLengthIntegerThe length of card PINs generated for smart credentials for this SC Defn.[optional]
cardPinLowerCardPinLowerEnumRequirements for lowercase letters in card PINs for smart credentials for this SC Defn.[optional]
cardPinMaxAttemptsIntegerThe maximum number of times a wrong PIN can be entered incorrectly before it locks out the smart credential.[optional]
cardPinMaxLengthIntegerThe maximum PIN length of card PINs for smart credentials for this SC Defn.[optional]
cardPinMaxUsesAfterAdminResetIntegerThe maximum number of times a PIN can be used before it must be changed after it is set by an administrator.[optional]
cardPinMinLengthIntegerThe minimum PIN length of card PINs for smart credentials for this SC Defn.[optional]
cardPinSpecialCardPinSpecialEnumRequirements for special characters in card PINs for smart credentials for this SC Defn.[optional]
cardPinUpperCardPinUpperEnumRequirements for uppercase letters in card PINs for smart credentials for this SC Defn.[optional]
defaultCardDigitalIdConfigIdStringThe UUID of the default card digital id config. If not set, there is no default.[optional]
defaultCardHolderDigitalIdConfigIdStringThe UUID of the default card holder digital id config. If not set, there is no default.[optional]
defaultSCDefnBooleanA flag indicating if this is the default SC Defn.[optional]
idStringThe UUID of this SC Defn.[optional]
lifetimeIntegerThe lifetime of smart credentials created for this SC Defn.[optional]
nameStringThe name of this SC Defn.[optional]
pivAppletConfigIdStringThe UUID of the PIV applet configuration associated with this smart credential definition.[optional]
pivContentSignerCAIdStringThe UUID of the CA that defines the PIV Content Signer for this SC definition. If not set, the PIV Content Signer is derived from the digital id configs.[optional]
variablesList<SCDefnVariable>Smart Credential Definition Variables defined for this SC Defn.[optional]

CardPinDigitsEnum

NameValue
ALLOWED"ALLOWED"
REQUIRED"REQUIRED"
NOT_ALLOWED"NOT_ALLOWED"
NOT_SET"NOT_SET"

CardPinLowerEnum

NameValue
ALLOWED"ALLOWED"
REQUIRED"REQUIRED"
NOT_ALLOWED"NOT_ALLOWED"
NOT_SET"NOT_SET"

CardPinSpecialEnum

NameValue
ALLOWED"ALLOWED"
REQUIRED"REQUIRED"
NOT_ALLOWED"NOT_ALLOWED"
NOT_SET"NOT_SET"

CardPinUpperEnum

NameValue
ALLOWED"ALLOWED"
REQUIRED"REQUIRED"
NOT_ALLOWED"NOT_ALLOWED"
NOT_SET"NOT_SET"