Skip to main content

KOBIL User Attribute Handler

KOBIL User Attribute Handler

Main task of this execution is to add/update and remove the attributes provided through the User Attribute Name/Value field and JSON format.

Type

ProtocolOpenID Connect 1.0
HTTP methodGET
TypeBrowser Flow
EndpointAuthorization Endpoint
Flow SupportedAuthorization code flow
Implicit flow
Hybrid flow
ResponseID Token, Access Token, Refresh Token
Response Modequery, form_post, fragment

How to configure

To access the config of the execution press the Settings button and select Config. The authenticator configuration screen will appear. Then enter your config data.

KOBIL User Attribute Handler flow

Note: User Enabled should be set to ON.

Configuration

Parameters involved in KOBIL User Attribute Handler execution
ParameterDescription
IDUnique system UUID, which will be assigned automatically to record in a database.
AliasName for the overall configured configurations which occurs in particular authenticator.
User Attribute NameProvide a name of the "key" send during authentication request.
User Attribute ValueProvide a name of the "Value" send during authentication request.

While execution the attributes present in JSON format will be considered as the highest priority even if the value present in User Attribute Name/Value field.

KOBIL User Attribute Handler flow

Sample Request Body

In order to add/update and remove the attributes use the below JSON formats.

To remove:

{
"attribute_name1": {
"removeAttribute": "true"
}
}

To add/update:

{
"attribute_name2": {
"attributeValue": "value"
}
}

User Flow

Execution Flow

This execution contains following main steps:

  1. It is mandatory that KOBIL User Attribute Handler must be preceded by another Authenticator, since it procures username from this precedent authenticator. For instance: KOBIL Username Password Form for user identification.
  2. The authenticator will receive a collection of attributes in the authenticator configuration as a JSON file and it will add/remove the attributes depending on the supplied JSON.
  3. The backward compatibility of a single attribute upgrade has also been established.
KOBIL User Attribute Handler flow