dsappSRPRegister (Command)

The dsappSRPRegister command authenticates the user and initiates a Digipass Software Advanced Provisioning Protocol-Secure Remote Password (DSAPP-SRP) provisioning operation.

Parameters

Table: dsappSRPRegister input parameters (SOAP provisioning)
Parameter name	Data type	Description
activationType	Integer	Optional. Determines if dsappSRPRegister should generate online or offline activation data. Possible values: 0. Generate online activation data. 1. Generate offline activation data. If any other integer value is specified, the activation data is derived from the initial configuration in the DPX. Default value: Use DPX configuration
componentType	String	Required. Specifies the client component to serve the request.
user	UserInput	Required. The user input information (see UserInput (Data type)). This specifies the user to be authenticated for the provisioning operation.
credential	RegisterCredentialInput	Required. The credential parameters used to authenticate the user.
serialNumber	String	Optional. The serial number of the authenticator to be used for the registration. This is required if the user account has more than one authenticator assigned. If the serial number is invalid, the command fails.

Table: dsappSRPRegister output parameters (SOAP Administration)
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	DSAPPSRPRegisterResult	Optional. The output fields for this command, returning information about the registration ID and the activation password.
result	DSAPPSRPRegisterResult2	Optional. Additional output fields to provide the DIGIPASS Gateway ID, user output information, and authenticator serial number.

UserInput (Data type)

Table: UserInput (Data type)
Element name	Data type	Description
userID	String	The user ID.
domain	String	Optional. The user domain.

RegisterCredentialInput (Data type)

Table: RegisterCredentialInput (Data type)
Element name	Data type	Description
staticPassword	String	The current static password of the user.

DSAPPSRPRegisterResult (Data type)

Table: DSAPPSRPRegisterResult (Data type)
Element name	Data type	Description
registrationID	String	The ID of the user to be authenticated.
activationPassword	String	The user password generated by the DSAPP server.

DSAPPSRPRegisterResult2 (Data type)

The DSAPPSRPRegisterResult2 data type extends DSAPPSRPRegisterResult.

Table: DSAPPSRPRegisterResult2 (Data type)
Element name	Data type	Description
registrationID	String	The ID of the user to be authenticated.
activationPassword	String	The user password generated by the DSAPP server.
user	UserOutput	The user output information (see UserOutput (Data type)).
serialNumber	String	Serial number of the authenticator used for provisioning.
digipassGatewayID	String	The DIGIPASS Gateway ID that is configured to be contacted by the client application to use the cloud service.

UserOutput (Data type)

The credentials of the user who uses the cloud service.

Table: UserOutput (Data type)
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:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header/>
  <soapenv:Body>
    <prov:dsappSRPRegister xmlns:prov="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Provisioning">
      <componentType>srp-component</componentType>
      <user>
        <userID>user1</userID>
        <domain>master</domain>
      </user>
      <credential>
        <staticPassword>Password2</staticPassword>
      </credential>
    </prov:dsappSRPRegister>
  </soapenv:Body>
</soapenv:Envelope>