API parameters specific to Smart ID Desktop App

"driver"

Identifies the token in case of profile PIN reset.

The value is json with two fields:

• Name
  Accepted values: "yubi", "cardos", "any", "c2300", "gemalto", "vsc"
  
  
• Type
  Accepted values: "minidriver" or "pkcs11" 

"operation"

If not specified, PIN reset is performed.

Accepted values:

• "pinreset", "adminkeychange", "pinchange","pukchange"

“smartcardid”

Unique minidriver-based token identifier. This parameter is used to identify the token in case of a profile-less operation. (To identify the token, it is enough to specify one of the fields “smartcardid” or “driver”).

"profileid"

Identifies the profile within the Smart Id Desktop App, on which the operation is executed. (If the values for "smartcardid" and "profileid" identified with the profile are different, the value for "smartcardid" should be used.)

“nonce”

"transportedkey"

"encryptedpayload"

“encryptednonce”

“smartcardid”

Defines which profile in Smart ID Desktop App that is targeted.

“newadminkey”

Optional.

If present, instead of initiating a PIN reset, it actually changes previous adminkey to the current one.

Hexencoded adminkey, which means 48 lowercase ASCI characters encoding 24 bytes of the new key.

“smartcardid”

"desktopKeyProtectionLevel"

• "NONE" means there is no confirmation action required to use the key.
• "CONSENT" means you get a dialogue from Windows asking for simple confirmation.
• "PASSWORD" means you need to enter it once you session to use it.
• "BIOMETRICS" is for the future and will work depending on the capabilities of the device, where the keys are stored.

These options are only supported for software keys.

“deviceinfo”:”true”/”false”

If true, the response will contain a set named deviceinfo with the following content:

• “operatingsystem” - version of Windows 10
• “name” - computer name
• “model” - version of Smart ID Desktop App

If true, the response will contain an array with each set having the following content:

• "guid" - a unique card identifier (a 16 byte random number tied to the given smartcard/token)
• "name" - profile human readable name
• "issuer" - issuer name
• “pid” - profile id
• “activated” - date of profile activation
• “certificates” - comma separated list of cert hashes

Used if you want to receive profileinfo. Use a specific profileid to gather all profiles associated with it in a given installation.

“vscinfo”:”smartcardid”

This option is designed to support a specific use case of Yubico Yubikey provisioning in Windows kiosk mode, but may be useful elsewhere. Default it is set to false.

If set to true, the certificates from the cert store are deleted and the profile itself is deleted from Smart ID Desktop App, upon successful conclusion of the ImportCertificate process. Note that reinserting a Yubico Yubikey token imports the certificates to the cert store, as the token also stores these certificates and shares this property with most physical smart cards.

For information about importing certificates, see Import PKCS#12 file into Smart ID Desktop App. You can set Yubikey as Target for P12 import, see Advanced settings in Smart ID Desktop App.

Value: [message]. When this key is included, [message] is displayed upon successful provisioning and import cert is concluded instead of a default one.

If the TPM does not accept a certain key to be imported via Smart ID Desktop App, the Hybrid Profile can be used. With the Hybrid Profile concept, one Virtual Smart Card (VSC) can store its associated keys in different storages (for example, TPM or soft key store) under the same VSC.

Storageprio defines the behaviour of the Hybrid Profile, for example, storageprio 1=TPM, storageprio 2=OS will try TPM and fallback to OS if TPM fails.

If this desktopExtensions is set, a Hybrid Profile is created,

"desktopKeyProtectionLevel"

• "NONE" means there is no confirmation action required to use the key.
• "CONSENT" means you get a dialogue from Windows asking for simple confirmation.
• "PASSWORD" means you need to enter it once you session to use it.
• "BIOMETRICS" is for the future and will work depending on the capabilities of the device, where the keys are stored.

These options are only supported for software keys.

• "YUBI" - means that Smart ID Desktop App shall store keys on Yubico YubiKey token
• "OS" - means that Smart ID Desktop App shall store keys in the software (use software keys)
• "APP" - means that Smart ID Desktop App shall store keys on a virtual smartcard
• “TPM” – means that Smart ID Desktop App shall store keys individually on the TPM

• If set to true - wipe Yubico YubiKey token and force a pin change. After wipe, the pin is set to 123456.
• If set to false - do not wipe Yubico YubiKey token and do not force pin change.

Default: true

Same as for "wipeyubi" but for smart cards. The card must support wiping (that is, deleting the contents of a card and returning it to “factory” setting). This is not mandatory and not all cards support it. It is set by the token manufacturer.

Default: false

• If set to true - Slightly simpler provisioning structure, which results in one less pin entry during provisioning as the signature does not have to be created. 
• If set to false - The provisioning process takes slightly longer as each created key has to perform extra signing operation, which also requires pin entry.

Default: false

"profileid”

“vscinfo”:”oldadminkey“

“vscinfo”:”adminkey“

“vscinfo”:”smartcardid”

"confirmed“:“true“/“false“