IOTPProvider
Add-in responsible for generating an OTP code and validate it afterwards, this addin is triggered whenever a user clicks on a signature field and chooses signature method OTP.
This addin is commonly used to integrate with existing OTP providers from third-parties.
Trigger Event(s): Sign |
Method | Description | ||
---|---|---|---|
generate |
Generates OTP request |
||
Parameter |
Type |
Description |
|
context |
ArtifactContext |
Context of the artifact (artifact variables and properties) with read-only access |
|
objectId |
String |
Artifact object over which the OTP was requested (ex: signature field id) |
|
user |
String |
User requesting the OTP (if the session is authenticated). This field is deprecated, as information of the user in context can now be obtained with SecurityManager.getSession(). |
|
Returns |
Type |
Description |
|
result |
String |
A unique identifier of the OTP session |
|
- |
- |
- |
|
validate |
Validates a given password against a previously generated OTP request |
||
Parameter |
Type |
Description |
|
context |
ArtifactContext |
Context of the artifact (artifact variables and properties) with read-only access |
|
session |
String |
Unique identifier of the OTP session (output of the generate call) |
|
password |
String |
OTP to be validated (value inserted by the user) |
|
Returns |
Type |
Description |
|
result |
Boolean |
True if validation succeed; otherwise returns false |