https://github.com/curityio/lookup-account-auth-action

An authentication action plugin which allows to fetch account attributes based on an account manager.
https://github.com/curityio/lookup-account-auth-action

account-lookup authentication-action plugin

Last synced: 12 months ago
JSON representation

An authentication action plugin which allows to fetch account attributes based on an account manager.

• Host: GitHub
• URL: https://github.com/curityio/lookup-account-auth-action
• Owner: curityio
• License: apache-2.0
• Created: 2022-08-23T11:15:51.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-09-25T08:49:57.000Z (over 2 years ago)
• Last Synced: 2025-06-03T20:05:23.365Z (about 1 year ago)
• Topics: account-lookup, authentication-action, plugin
• Language: Java
• Homepage:
• Size: 199 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
Lookup Account Authentication Action Plugin

=============================================

.. image:: https://img.shields.io/badge/quality-production-green

   :target: https://curity.io/resources/code-examples/status/

   :alt: Quality

.. image:: https://img.shields.io/badge/availability-source-blue

   :target: https://curity.io/resources/code-examples/status/

   :alt: Availability

A custom authentication action plugin for the Curity Identity Server. You can add this action to any curity authenticator to fetch the user's account attributes from the underlying datasource.

Building the Plugin

~~~~~~~~~~~~~~~~~~~

Build the plugin by issuing the command ``mvn package``. This will produce a JAR file in the ``target`` directory,

which can be installed.

Installing the Plugin

~~~~~~~~~~~~~~~~~~~~~

To install the plugin, copy the compiled JAR (and all of its dependencies) into the :file:`${IDSVR_HOME}/usr/share/plugins/${pluginGroup}`

on each node, including the admin node. For more information about installing plugins, refer to `curity.io/plugins`_.

Required Dependencies

"""""""""""""""""""""

You need at least version 7.3.0 of the Curity Identity Server to use this plugin.

For a list of the dependencies and their versions, run ``mvn dependency:list``. Ensure that all of these are installed in

the plugin group. Otherwise, they will not be accessible to this plug-in and run-time errors will result.

Configuring the Plugin

~~~~~~~~~~~~~~~~~~~~~~

You need to configure the following options for the plugin:

.. image:: docs/authentication-action-config.png

  :alt: Configuration in the admin UI

.. list-table::

   :widths: 25 25 50

   :header-rows: 1

   * - Configuration

     - Mandatory

     - Description

   * - Account Manager

     - Yes

     - The Account manager that will be used to retrieve the user's account attributes from the datasource

   * - Abort Authentication If User Not Found

     - No

     - The Action plugin aborts the authentication flow if the looked up user is not found in the underlying datasource

   * - Attribute Location

     - No

     - The location where the looked-up account attributes should be added

   * - Source Attribute Name

     - No

     - The attribute to be used by the lookup method for searching the user

   * - Lookup Method

     - No

     - The method to be used for looking up the user. Supported methods are ``BY_USERNAME, BY_EMAIL, BY_PHONE``

   * - Include Devices

     - No

     - The account attributes will include devices

More Information

~~~~~~~~~~~~~~~~

Please visit `curity.io`_ for more information about the Curity Identity Server.

.. _curity.io/plugins: https://support.curity.io/docs/latest/developer-guide/plugins/index.html#plugin-installation

.. _curity.io: https://curity.io/