IssueAssignmentValve
Note
Issue an assignment to One Touch device.
Properties
| Name | Description | Default value | Mandatory | Supports property expansion |
|---|---|---|---|---|
| userNameParameter | Target userID value. | Yes | Yes | |
| serviceName | Display name of the service wanting access. | No | No | |
| authMessage | The message to be shown before username. | No | No | |
| serviceMessage | Message shown after username. | false | No | No |
| completeURL | Where to send client after confirmation. Not applicable when valve is part of pipe triggered through API. | false | No | Yes |
| clientTemplate | Assignment template to use. Must be present in the resources folder on the server. | ot_auth_template.json | No | No |
Properties exclusive to OneTouch v2
| Name | Description | Default value | Mandatory | Supports property expansion |
|---|---|---|---|---|
| authIntent | A short string describing the intent of the authentication. Example: 'Login to SomeIDP' (only available in OneTouch v2) | Yes, unless sign transaction | Yes | |
| authMessage | A short message presented in the OneTouch app. Supports basic markdown. | No | Yes | |
| authMessageB64 | A base64 encoded short message presented in the OneTouch app. Supports basic markdown. Overrides 'authMessage' config parameter. | No | Yes | |
| signMessage | A short message presented in the OneTouch app for signing. Setting this will make it into a sign-transaction. Supports basic markdown. | No | Yes | |
| signMessageB64 | A base64 encoded short sign message presented in the OneTouch app. Supports basic markdown. Overrides 'signMessage' config parameter. | No | Yes | |
| biometric_auth_allowed | Whether or not biometric authentication (FaceID / Fingerprint) should be allowed instead of a pin code. | true | No | NO |
Example Configuration
{
"name" : "IssueAssignmentValve",
"config" : {
"userNameParameter" : "{{request.username}}",
"serviceName" : "Phenixid",
"authMessage" : "Approving password change for user:",
"serviceMessage" : "VPN service:",
"completeURL" : "http://192.168.10.194:8080/reset/authenticate/reset/?proceed=true",
"clientTemplate" : "my_ot_template.json"
}
}
Requirements
User must have One Touch enrolled.