Skip to main content

Get a smart credential definition

GET 
/api/web/v1/scdefns/:id

Get the smart credential definition for the specified UUID. Caller requires the SCDEFNS:VIEW permission.

Request​

Path Parameters

    id stringrequired

    The UUID of the smart credential definition to be retrieved.

Responses​

Successful

Schema

    cardDigitalIdConfigRequired boolean

    A flag indicating if smart credentials using this SC definition must have a card digital id config defined.

    cardHolderDigitalIdConfigRequired boolean

    A flag indicating if smart credentials using this SC definition must have a card holder digital id config defined.

    cardPinDigits string

    Possible values: [ALLOWED, REQUIRED, NOT_ALLOWED, NOT_SET]

    Requirements for digits in card PINs for smart credentials for this SC Defn.

    cardPinLength int32

    The length of card PINs generated for smart credentials for this SC Defn.

    cardPinLower string

    Possible values: [ALLOWED, REQUIRED, NOT_ALLOWED, NOT_SET]

    Requirements for lowercase letters in card PINs for smart credentials for this SC Defn.

    cardPinMaxAttempts int32

    The maximum number of times a wrong PIN can be entered incorrectly before it locks out the smart credential.

    cardPinMaxLength int32

    The maximum PIN length of card PINs for smart credentials for this SC Defn.

    cardPinMaxUsesAfterAdminReset int32

    The maximum number of times a PIN can be used before it must be changed after it is set by an administrator.

    cardPinMinLength int32

    The minimum PIN length of card PINs for smart credentials for this SC Defn.

    cardPinSpecial string

    Possible values: [ALLOWED, REQUIRED, NOT_ALLOWED, NOT_SET]

    Requirements for special characters in card PINs for smart credentials for this SC Defn.

    cardPinUpper string

    Possible values: [ALLOWED, REQUIRED, NOT_ALLOWED, NOT_SET]

    Requirements for uppercase letters in card PINs for smart credentials for this SC Defn.

    defaultCardDigitalIdConfigId string

    The UUID of the default card digital id config. If not set, there is no default.

    defaultCardHolderDigitalIdConfigId string

    The UUID of the default card holder digital id config. If not set, there is no default.

    defaultSCDefn boolean

    A flag indicating if this is the default SC Defn.

    id string

    The UUID of this SC Defn.

    lifetime int32

    The lifetime of smart credentials created for this SC Defn.

    name string

    The name of this SC Defn.

    pivAppletConfigId string

    The UUID of the PIV applet configuration associated with this smart credential definition.

    pivContentSignerCAId string

    The 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.

    variables

    object[]

    Smart Credential Definition Variables defined for this SC Defn.

  • Array [

    • defaultValue string

    The default value of this variable.

    displayable boolean

    A flag indicating if values for this variable should be displayed.

    generate boolean

    A flag indicating if the initial value for this variable should be generated.

    generateLength int32

    A length value used when generating values for this variable.

    id string

    The UUID of this SC Defn Variable.

    modifiable boolean

    A flag indicating if values for this variable can be modified.

    name string

    The name of this SC Defn Variable.

    order int32

    A value that specifies the order of this variable with respect to the other variables in the SC Defn.

    prompt string

    Optional prompt to be used when prompting for a value for this variable.

    required boolean

    A flag indicating if a value is required for this variable.

    restrictionDigits string

    Possible values: [ALLOWED, REQUIRED, NOT_ALLOWED, NOT_SET]

    A value specifying restrictions on digits appearing in values of this variable.

    restrictionLower string

    Possible values: [ALLOWED, REQUIRED, NOT_ALLOWED, NOT_SET]

    A value specifying restrictions on lowercase characters appearing in values of this variable.

    restrictionMax int32

    A value indicating a maximum for values of this variable. How this is enforced depends on the variable type.

    restrictionMin int32

    A value indicating a minimum for values of this variable. How this is enforced depends on the variable type.

    restrictionRegex string

    A value specifying a regex that values of this variable must match.

    restrictionSpecial string

    Possible values: [ALLOWED, REQUIRED, NOT_ALLOWED, NOT_SET]

    A value specifying restrictions on special characters appearing in values of this variable.

    restrictionUpper string

    Possible values: [ALLOWED, REQUIRED, NOT_ALLOWED, NOT_SET]

    A value specifying restrictions on uppercase characters appearing in values of this variable.

    scDefnId string

    The UUID of the SC Defn that owns this variable definition.

    type string

    Possible values: [STRING, BOOLEAN, INTEGER, UUID]

    The type of this variable.

    uniqueness string

    Possible values: [GLOBAL, USER, NONE]

    A flag indicating if values of this variable must be unique and if so within what scope.

    uniquenessScopeId string

    A value that allows a variable to be defined unique in the scope of another variable.

  • ]

Loading...