Skip to main content

Update a smart credential

PUT 
/api/web/v1/smartcredentials/:id

Update the specified smart credential. Caller requires the SMARTCREDENTIALS:EDIT permission.

Request​

Path Parameters

    id stringrequired

    The UUID of the smart credential to be modified.

Body

required

    cardDigitalConfigId string

    The UUID of the Card Digital Id config of this smart credential. It can be specified in either the create or update operations. If not set, the smart credential will not have a Card Digital Id.

    cardHolderDigitalConfigId string

    The UUID of the Card Holder Digital Id config of this smart credential. It can be specified in either the create or update operations. If not set, the smart credential will not have a Card Holder Digital Id.

    scDefnId string

    The UUID of the Smart Credential Definition that defines this smart credential. It must be specified when the smart credential is created and can be updated for an existing smart credential.

    state string

    Possible values: [ACTIVE, INACTIVE]

    The state of the smart credential. Only smart credentials in the ACTIVE state can be used for authentication.

    userId string

    The UUID of the user that owns this smart credential. This value must be specified when the smart credential is created and is read-only after that.

    variableValues

    object[]

    When creating or modifying a smart credential, the variable values specify a list of variable values to be set.

  • Array [

    • scDefnVariable

    object

    SC Defn Variables define the details about variables defined in the SC Defn.

    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.

    scDefnVariableId string

    The UUID of the SC Defn Variable that defines the variable.

    value string

    The variable value.

  • ]

Responses​

Successful

Loading...