...
| REST parameter | data type | description |
|---|---|---|
| spAccountLoginName | string | SurePassID account login name |
| spAccountLoginKey | string | SurePassID account login key |
| username | string | User account login name |
| type | string | add_oath_device |
| deviceType | short | Device Type |
| OtpType | short | OTP Type |
| OtpLength | short | The length of the desired OTP. |
| windowSize | short | The sliding window for OTP validation. For event based OTP Type this is the number of values > than the event counter that will be accepted. For time based OTP Type this is the number of seconds that will elapse before the OTP will change. |
| OtpPin | short | The pin associated with device for OTP Type that require a PIN |
| timeDrift | short | The number of allowable time drift increments to be used as part of the calculation. |
| psn | string | The device serial number for the device. If this field is not specified then a serial number will be generated by the system. For hardware devices such as FOBS this field is recommended since these devices usually come serialized. For soft devices such as mobile otp generators, it is recommended to not specify a serial number and let the system create one automatically. The generated serial number will be returned in the response. |
| secretKeyHex | string | The secret key (in hex format) for the device. If this field is not specified then a secure secret key will be generated by the system. For hardware devices such as FOBS this field is recommended since these devices usually come with predefined keys. For soft devices such as mobile otp generators, it is recommended to not specify a secret key and let the system create one automatically. |
| secretKeyHexBase64 | string | The secret key (Base64 format) for the device. If this field is not specified then a secure secret key will be generated by the system. For hardware devices such as FOBS this field is recommended since these devices usually come with predefined keys. For soft devices such as mobile otp generators, it is recommended to not specify a secret key and let the system create one automatically. |
| notificationMethod | short | send Send welcome message to user. 0=none, 1=email, 2=sms |
| mobileAuth | short | User provisioning authentication. 0=none (default) , 1= require username and password |
| mobileUsage | short | Mobile token usage. 0=push only, 1=otp only (default), 2=push and otp |
| softTokenAlias | string | Sets the token user defined name. Leave this blank to take the default. |
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"username": "Mandy",
"spAccountLoginName": "accountLogin",
"spAccountLoginKey": "accountKey",
"type": "add_oath_device",
"deviceType ": 1, // key fob token
"OtpType": 1, // time based otp
"OtpLength": 6, // otp digits
"windowSize": 30, // time window in seconds
"OtpPin": "", // no pin for time based otp
"psn": "OATH_12345678",
"secretKeyHex": "3132333435363738383031323334353637383830",
"notificationMethod": 0, // no notification
"mobileAuth": 0 // no user provisioning authentication
"mobileUsage": 1, // otp mobile token
"softTokenAlias": "Jims test token", // a text value that sets the token user defined name
}
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"errorCode": 0,
"errorMessage": "OK",
"type": "add_oath_devive"
} |
...