API version: 2
Availability: DIGIPASS Gateway 5.0 and later
Authentication: Basic HTTP authentication using the back-end API key.
The MdlRegister service performs a provisioning registration operation by generating Activation Message 1 for a specific user.
URL
https://dpgateway_host:dpgateway_port/rest/v2/provisioning/MdlRegister
Request
MdlRegister parameters | ||
Parameter name | Data type | Description |
|---|---|---|
domain | String | Optional. The user domain. |
password | String | Required. The static password of the user. |
userID | String | Required. The user name. |
Example/
{
"userID": "jane.doe",
"domain": "mydomain.com",
"password": "myPassword"
}Response
MdlRegister return values | |
Return value | Description |
|---|---|
resultCodes | A JSON object that contains the return and status codes of the service. |
result | A JSON object that contains the generated registration activation data. |
Example
{
"resultCodes":
{
"returnCodeEnum": "RET_SUCCESS",
"statusCodeEnum": "STAT_SUCCESS",
"returnCode": 0,
"statusCode": 0
},
"result":
{
"registrationIdentifier": "e3wfISG9",
"activationMessageImage": "BBED4D1C617F42C8D496B36F0137AE5E..."
}
}