Impersonate with search

Customisable object selector.

Introduction

The Impersonate selector is responsible for presenting a list of objects (in a grid) for the user to select from.

The Impersonate selector completes when the user has selected an option.

Can be nestled with other authenticators, selectors and chains.

Configuration

Common Authenticator configuration can be found here.

Properties
Example

Name	Description	Default	Mandatory
`pipe_id`	Reference to the pipe responsible for collecting the data to be presented in the grid. Request parameter `"search"` contains the value from the search input field.	N/A	true
`identifier_attribute`	What attribute serves as the selected identifier.	`"sAMAccountName"`	false
`selected_id_parameter`	Name of attribute where selected identifier will be put.	`"object_id"`	false
`include_self`	If the authenticated user should be a selectable option. Enables the 'Login as myself' button.	`false`	false
`show_filtering`	Enable filtering in UI.	`true`	false
`values`	See Values below.	N/A	true
`exec_if`	An expression that determins if this authenicator should be executed or not. If left unconfigured, the authenticator will execute.	N/A	false
`webroot_dir`	See common authenticator configuration	`"web/authenticator/impersonate_selector"`	false

{
   "id":"auth00_select_object",
   "type":"ImpersonateWithSearch",
   "config":{
      "base_path":"/test/authn",
      "pipe_id":"search_pipe",
      "values":[
         {
            "key":"role",
            "label":"label1"
         },
         {
            "key":"givenName",
            "label":"label2"
         },
         {
            "key":"mail",
            "label":"label3"
         }
      ],
      "custom_identifier":"FortifiedID",
      "identifier_attribute":"sAMAccountName",
      "selected_id_parameter":"object_id",
      "include_self":false,
      "show_filtering":true,
      "webroot_dir":"web/authenticator/impersonate_selector"
   }
}

Values

The values array represents the columns to be shown in the grid.

Properties
Example

Name	Description	Default	Mandatory
`key`	Item parameter. The value will be presented in the column for each object.		true
`label`	Column label translation key.		true

"values":[
         {
            "key":"displayName",
            "label":"label1"
         },
         {
            "key":"givenName",
            "label":"label2"
         },
         {
            "key":"sAMAccountName",
            "label":"label3"
         },
         {
            "key":"mail",
            "label":"label4"
         },
         {
            "key":"cn",
            "label":"label5"
         }
      ]

Data exposed to global state

When a value is selected, the ImpersonateWithSearch authenticator is marked as done and populates the configured selected_id_parameter property with the identifier value obtained from the selection.

Logging

WEB_100040("Impersonate selector completed")
- IDENTIFIER (user trace id)
- CUSTOMER_IDENTIFIER (if configured)
- SOURCE_USER_NAME (subject of authenticated user)
- SOURCE_ADDRESS (ip of the remote session)

API

API follows the general conventions of the Fortified Web Authenticator API.

Messages

Selector authenticators supports the following messages:

Init (request+response)

Init message must be sent before/during the view is loading. Response contains the options that should be presented to the user.

Init may be called while authenticator is in progress under the following circumstances:

Callback from selected authenticator
Browser reload (user refreshes page)
Browser back (user cancels selected authenticator and navigates back)

{
  "type" : "init",
  "data" : {}
}

{
  "type" : "init",
  "success" : true,
  "data" : {
    "options" : [
      {
        "id" : "<option-id>",
        "target" : "<authenticator-id>",
        "label" : "<option-text-or-translation-key>
      },
    ]
  }
}

Reason	Description
Selected authenticator failed	The selected authenticator failed.
Unknown status: <status>	The selected authenticator has an unknown status (Not `PENDING`, `IN_PROGRESS`, `COMPLETED` or `FAILED`)
Invalid status: <status>	Protocol error. Init called when authenticator is not in status `PENDING` or `IN_PROGRESS`.

Action (request+response)

The action message is used for selecting an option. This message is triggered by a user action.

{
  "type" : "action",
  "data" : {
    "selected" : "<option-id>"
  }
}

{
  "type" : "action",
  "success" : true,
  "data" : {
    "location" : "<path-to-selected-authenticator>"
  }
}

Reason	Description
Invalid option: <option-id>	An invalid option-id was supplied. Only option-ids from init are valid.
Invalid state	Protocol error. Operation is called in an invalid state, for example if `action` is called before `init`.

Complete (response)

The complete response message is sent when the authentication has completed. If message contains a location property; view must redirect user agent to the supplied location.

Response

{
  "type" : "complete",
  "success" : true,
  "data" : {
    "location" : "<next-location>"
  }
}

Translation keys

Default translations provided:

English, assets/locales/en.json

{
  "impersonate_selector.header": "Choose",
  "impersonate_selector.paragraph": "Choose a user to impersonate",
  "impersonate_selector.label1": "Label 1",
  "impersonate_selector.label2": "Label 2",
  "impersonate_selector.label3": "Label 3",
  "impersonate_selector.label4": "Label 4",
  "impersonate_selector.label5": "Label 5",
  "impersonate_selector.label6": "Label 6",
  "impersonate_selector.label7": "Label 7",
  "impersonate_selector.label8": "Label 8",
  "impersonate_selector.label9": "Label 9",
  "impersonate_selector.label10": "Label 10",
  "impersonate_selector.error": "An error occurred",
  "impersonate_selector.cancel": "Cancel",
  "impersonate_selector.search": "Search",
  "impersonate_selector.search.no_results": "Search returned no results",
  "impersonate_selector.self_button": "Login as myself",
  "impersonate_selector.processing": "Your selection is being processed, please wait ...",
  "allow-cookies-header": "Allow cookies",
  "allow-cookies-body": "To save your language settings on this device you need to allow cookies.",
  "allow-cookies-button": "Allow cookies",
  "allow-cookies-dismiss": "Dismiss",
  "table.page": "Page {{pageIndex}} of {{pageCount}}",
  "table.select_placeholder": "Select...",
  "change_language": "Change language",
  "table.export": "Export",
  "table.no_results": "No results",
  "authentication.help_text": ""
}

Swedish, assets/locales/sv.json

{
  "impersonate_selector.header": "Välj",
  "impersonate_selector.paragraph": "Välj en användare att logga in som",
  "impersonate_selector.label1": "Rubrik 1",
  "impersonate_selector.label2": "Rubrik 2",
  "impersonate_selector.label3": "Rubrik 3",
  "impersonate_selector.label4": "Rubrik 4",
  "impersonate_selector.label5": "Rubrik 5",
  "impersonate_selector.label6": "Rubrik 6",
  "impersonate_selector.label7": "Rubrik 7",
  "impersonate_selector.label8": "Rubrik 8",
  "impersonate_selector.label9": "Rubrik 9",
  "impersonate_selector.label10": "Rubrik 10",
  "impersonate_selector.error": "Ett fel har inträffat",
  "impersonate_selector.cancel": "Avbryt",
  "impersonate_selector.search": "Sök",
  "impersonate_selector.search.no_results": "Sökningen gav inga resultat",
  "impersonate_selector.self_button": "Logga in som mig själv",
  "impersonate_selector.processing": "Ditt val behandlas, vänta ...",
  "allow-cookies-header": "Tillåt cookies",
  "allow-cookies-body": "Vill du spara dina språkinställningar på denna enhet behöver du tillåta cookies",
  "allow-cookies-button": "Tillåt cookies",
  "allow-cookies-dismiss": "Avfärda",
  "table.page": "Sida {{pageIndex}} av {{pageCount}}",
  "table.select_placeholder": "Välj...",
  "change_language": "Byt språk",
  "table.export": "Exportera",
  "table.no_results": "Inget resultat",
  "authentication.help_text": ""
}