dpCSVFileUploadMTOM (Command)

Mis à jour le 20 Dec 2024
1 Minute à lire

Partager
Sombre
Lumière
PDF

The content is currently unavailable in French. You are viewing the default English version.

Résumé de l’article

Avez-vous trouvé ce résumé utile ?

Merci pour vos commentaires

Availability: OneSpan Authentication Server 3.21 and later
Scenario: Administration

The dpCSVFileUploadMTOM command uploads a DIGIPASS import file using MTOM encoding. The authenticator data is stored in the vdsBlob table. To effectively import and process the data, you need to call dpCSVFileImport afterward (see dpCSVFileImport (Command)).

A DIGIPASS import file is a comma-separated text file (.csv) that contains authenticator records. They are used, for instance, to import authenticator data from an existing OneSpan Authentication Server Framework environment to OneSpan Authentication Server.

The import files are also used by Data Migration Tool (DMT). For more information about the DIGIPASS import file type and preparing such files, refer to the Data Migration Tool Administrator Guide.

Parameters

Table: dpCSVFileUploadMTOM input parameters
Parameter Name	Data type	Description
sessionID	String	Required. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see logon (Command)).
fileName	String	Required. The path and file name of the DIGIPASS import file to upload.
dpcsvfileData	Binary data (Hex)	Required. MTOM-encoded content of the DIGIPASS import file to upload.
taskDescription	String	Optional. An optional text to describe the task.
customStorageDeriveKey	String	Optional. An optional custom storage derive key used to decrypt the authenticator BLOB data. If you are migrating from OneSpan Authentication Server Framework, this is the storage derivation key. The derivation key is set using the four storage derive key kernel parameters, i.e. StorageDeriveKey1, StorageDeriveKey2, StorageDeriveKey3, and StorageDeriveKey4 as concatenated hexadecimal value.

Table: dpCSVFileUploadMTOM output parameters
Parameter name	Data type	Description
status	CommandStatusResponse	Required. The error stack, if applicable, which indicates that the command has not completed successfully. This also includes the result and status codes returned by the command.
result	dpCSVFileUploadMTOMResult	Optional. The result of the command (see dpCSVFileUploadMTOMResult (Data type)).

dpCSVFileUploadMTOMResult (Data type)

Table: dpCSVFileUploadMTOMResult (Data Type)
Parameter name	Data type	Description
fileName	String	The path and file name of the DIGIPASS import file to upload as specified in the input parameters.
cacheID	String	The unique identifier of the uploaded DIGIPASS import file generated by the server. Used to refer to the uploaded file later when importing the data.
applsTotal	Unsigned integer	The total number of authenticator application records read from the file.

Example

Upload a DIGIPASS import file using inline encoding:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header/>
  <soapenv:Body>
    <adm:dpCSVFileUploadMTOM xmlns:prov="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Administration">
      <sessionID>3JSK8cmRjw4E30wAA=0nUTL-~3fmifTO</sessionID>
      <fileName>myDigipassImportFile.csv</fileName>
      <dpcsvfileData>426c6f620d0a303039373132333435364150504c2031202020202020313041464941414141414141414141414141414141414141414141414141414141414141414141414141414141414141414141414141414141414141414141414141414141414141414141414147414145414141416749434141414143783462774f6d52596d3858594845726e6a42414a494157656362646873524849414141414141414141414141414141414141414141414141414141414141414141414141412b526d4f7a6d68316c4677414141594141514141414552514d7a4177414f494141414141414141414141443055376548626d6b4f305a4c6d336f744849794252</dpcsvfileData>
    </adm:dpCSVFileUploadMTOM>
  </soapenv:Body>
</soapenv:Envelope>

Upload a DIGIPASS import file using an XML-binary Optimized Packaging (XOP) reference:

--uuid:cd1761d6-ff45-40da-aec0-7e206ae1380d
Content-Id: <rootpart*cd1761d6-ff45-40da-aec0-7e206ae1380d>
Content-Type: application/xop+xml;charset=utf-8;type="text/xml"
Content-Transfer-Encoding: binary
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header/>
  <soapenv:Body>
    <adm:dpCSVFileUploadMTOM xmlns:prov="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Administration">
      <sessionID>3JSK8cmRjw4E30wAA=0nUTL-~3fmifTO</sessionID>
      <fileName>myDigipassImportFile.csv</fileName>
      <dpcsvfileData>
        <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:CSV"/>
      </dpcsvfileData>
    </adm:dpCSVFileUploadMTOM>
  </soapenv:Body>
</soapenv:Envelope>
 
--uuid:cd1761d6-ff45-40da-aec0-7e206ae1380d
Content-Id: <CSV>
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
[BINARY ATTACHMENT]
--uuid:cd1761d6-ff45-40da-aec0-7e206ae1380d--

Requirements

Required administrative privileges:

Import DIGIPASS

Cet article vous a-t-il été utile ?

What's Next

Test

Table des matières

Parameters
Example
Requirements