Dashboard - Endpoint Calls

Workflows Endpoints

The Acccess-Boston Dashboard uses the IdentityIq endpoint to request changes to a user's password, reset and register devices.

App Request Flow

  • Server Start, Init IdentityIq Service Connection

    • Requests are made by pages like the Change Password page to update a users data via the IdentityIq endpoint

    • The data from the UI is used as the params in the endpoint request

Workflows

digital/services-js/access-boston/src/server/services/IdentityIq.ts

WORKFLOW: Change Password (raw) request body

params from the .env file for the Change Password method

{
  "schemas": [
    {{LAUNCHED_WORKFLOW_SCHEMA}},
    {{TASK_RESULT_SCHEMA}}
  ],
  {{LAUNCHED_WORKFLOW_SCHEMA}}: {
    "workflowName": {{CHANGE_PASSWORD_WORKFLOW}},
    "input": [
		{
			"key": "currentSecret",
			"value": "@Password123"
		},
		{
			"key": "newSecret",
			"value": "@Password124"
		},
		{
			"key": "launcher",
			"value": "con123"
		},
		{
			"key": "transient",
			"value": "false"
		}
    ]
  }
}

WORKFLOW: Forgot Password (raw) request body

params from the .env file for the Change Password method

{
  "schemas": [
    {{LAUNCHED_WORKFLOW_SCHEMA}},
    {{TASK_RESULT_SCHEMA}}
  ],
  {{LAUNCHED_WORKFLOW_SCHEMA}}: {
    "workflowName": {{RESET_PASSWORD_WORKFLOW}},
    "input": [
		{
            "key": "token",
            "value": "string"
        },
        {
            "key": "newSecret",
            "value": "@Password124"
        },
        {
            "key": "launcher",
            "value": "con123"
        },
        {
            "key": "transient",
            "value": "false"
        }
    ]
  }
}


WORKFLOW: Update User Registry (raw) request body

params from the .env file for the Change Password method

{
  "schemas": [
    {{LAUNCHED_WORKFLOW_SCHEMA}},
    {{TASK_RESULT_SCHEMA}}
  ],
  {{LAUNCHED_WORKFLOW_SCHEMA}}: {
    "workflowName": {{REGISTER_USER_WORKFLOW}},
    "input": [
		{
			"key": "mfaEmail",
			"value": "[email protected]"
		},
		{
			"key": "mfaPhone",
			"value": "6174445555"
		},
		{
			"key": "launcher",
			"value": "con40001234"
		},
		{
			"key": "isUserRegistered",
			"value": "true"
		},
		{
			"key": "transient",
			"value": "false"
		}
    ]
  }
}

Last updated

Was this helpful?