authSignatureRequest (Command)
- 16 Dec 2024
- 1 Minute à lire
- SombreLumière
- PDF
authSignatureRequest (Command)
- Mis à jour le 16 Dec 2024
- 1 Minute à lire
- SombreLumiè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
The authSignatureRequest command initiates a data signing transaction. It creates a signature request key and distributes it to the respective authenticator applications via push notifications. The command suspends its working thread (releasing any database locks) and resumes after receiving a continue signal by another authSignature call.
The signing request is retrieved by the client using getPreparedSignatureRequest (see getPreparedSignatureRequest (Command)).
Parameters
| Parameter name | Data type | Description |
|---|---|---|
| componentType | String | Required. The name of the related client component. |
| user | UserInput | Required. The user account to be used. |
| serialNumber | String | Optional. The serial number of the authenticator to handle the signature request specifically. If omitted, a push notification is sent to any applicable authenticator instance. |
| push | PushSignatureRequest | Required. Choice element. The request method – push notification – is implicitly determined by the data type. The element body contains the signature data (see PushSignatureRequest (Data type)). |
| 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 | AuthSignatureRequestResult | Optional. The result of the command (see AuthSignatureRequestResult (Data type)). |
PushSignatureRequest (Data type)
The PushSignatureRequest type consists of a choice between different signature data types used for transaction data signing via push notification. For instance, a list of separate key/value signature data fields or a complete binary data signature body.
| Parameter name | Data type | Description |
|---|---|---|
| signatureFields | SignatureFields | Choice element. The signature data fields to sign (see Table: SignatureFields (Data type)). |
| signatureBody | Binary data (Hex) | Choice element. The hexadecimal binary data to sign. |
| Parameter name | Data type | Description |
|---|---|---|
| title | String | Title of the secure channel message. |
| dataField | DataField | Optional. Zero or more key/value data fields. |
AuthSignatureRequestResult (Data type)
| Parameter name | Data type | Description |
|---|---|---|
| user | UserOutput | The resolved user information (see Table: UserOutput (Data type)). |
| serialNumber | String | The serial number of the authenticator effectively used to complete the signing request. |
| Element name | Data type | Description |
|---|---|---|
| userID | String | The resolved user ID. |
| domain | String | The user domain. |
| orgUnit | String | Optional. The organizational unit of the user. |
Example
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header/>
<soapenv:Body>
<sig:authSignatureRequestxmlns:prov="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Signature">
<componentType>Push Notification Client</componentType>
<userxsi:type="BASIC-TYPES:UserInput">
<userID>user01</userID>
</user>
<serialNumber>12345678</serialNumber>
<pushxsi:type="SIGNATURE-TYPES:PushSignatureRequest">
<signatureBody>0F1F2F3F4F5F6F7F8F9F0FAFBFCFDFEFFF</signatureBody>
</push>
</sig:authSignatureRequest>
</soapenv:Body>
</soapenv:EnvelopeCet article vous a-t-il été utile ?