Older versionVersion 2.8SolutionsAdd action to One Touch

Add action to One Touch

This guide describes how to add Actions to the PhenixID One Touch app.

Requirements

  • One Touch must be configured.

Do the following steps in the ADVANCED  tab in the Configuration GUI.

Step 1 - Find the module

Find the "com.phenixidentity~phenix-pki" created by the One Touch scenario.

Step2 - Add the actions

Click on the pen to edit the "com.phenixidentity~phenix-pki" module.

Add the actions after the following row : "guide_id": "guides.onetouch",

Example actions

In the following example there are two actions

The first one acts only like a web link and will open the web page specified in the "url" option.

The second one will open the web page specified in the "url" option and add a JWT token that can be used to authenticate the user.

Add the following section to add actions :

<p>"actions_url" : "https://192.168.10.194:8443",
      "actions" : [ {
        "type" : "open",
        "url" : "http://www.phenixid.se/support",
        "title" : "Support",
        "text" : "Company website with support information"
      }, {
        "type" : "open",
        "url" : "https://192.168.10.194:8443/reset/authenticate/reset",
        "authentication" : "jwt",
        "title" : "Change password",
        "text" : "Click if you need a password reset"
      } ]</p>
Click to copy

Example config : 

{
	"name": "com.phenixidentity~phenix-pki",
	"enabled": "true",
	"config": {
		"issuer": "PhenixID",
		"ca_ref": "c4ed4b3c-712f-471e-aaaf-4fe818324a5b",
		"ca_profile": "c1667788-a453-420e-b0c8-15f1cc43da6c",
		"client_key_algorithm": "RSA",
		"client_key_size": "2048",
		"url_prefix": "https://192.168.10.194:8443",
		"http_configuration_ref": "0c5f7df1-2db2-42b9-8545-92a66d2fd821",
		"guide_ref": "efe738ed-5b03-4dd5-afad-5d736a59557a",
		"guide_id": "guides.onetouch",
		"actions_url": ""https://192.168.10.194:8443",
		"actions": [
			{
				"type": "open",
				"url": "http://www.phenixid.se/support",
				"title": "Support",
				"text": "Company website with support information"
			},
			{
				"type": "open",
				"url":"https://192.168.10.194:8443/reset/authenticate/reset",
				"authentication": "jwt",
				"title": "Change password",
				"text": "Click if you need a password reset"
			}
		]
	},
	"id": "114b63b7-f07a-4222-ad5b-3ca86f6e0ed4"
}

Replace the following to your requirements :

"actions_url"  :  Replace with the url in the option "url_prefix" in this module.

"url" : Replace with the link of your choice.

"title" : Replace with the title you want to be shown in the action list in the One Touch app.

"text": Replace with the help text to be shown on the action in the One touch app.

"icon": "<base 64 coded image show to left of the title>" - Supported from version 3.3

Step3 - Enroll profile

User with no profile enabled

To be able to use Actions in the PhenixID One Touch app the user have to enroll a One Touch profile. This can be done by either the PhenixID Activate One Touch feature or through the PhenixID Self Service feature.

User with a profile create before Action feature were enabled

If a user already had a PhenixID One Touch Profile before the Action feature were enabled the user has to enroll again to be able to use the Actions created. This can be done by either the PhenixID Activate One Touch feature or through the PhenixID Self Service feature.

Step4 - Add,Modify or Remove Actions

Actions can be added,modified or removed with out of the need for the user to enroll again.
*(Except in the case of  "User with a profile create before Action feature were enabled")

Adding, modifying or deleting a action is done in the Actions section of the module "com.phenixidentity~phenix-pki", see Step2 - Add the actions