Plug-ins enable you to extend the functionality of AuthMinder Server. Using the pluginConfigs element of the createRequest message, you can register and configure a plug-in.
The following table lists the pluginConfigs element of the createRequest message:
|
Element
|
Mandatory
|
Description
|
|
name
|
No
|
Name for the configuration.
|
|
status
|
No
|
Indicates the status of the configuration.
|
|
pluginConfigElements
|
No
|
Contains the following elements:
- name
Indicates the name of the plug-in that you want to configure.
- type
Indicates the type of the plug-in element. For example, integer, list, boolean, string, or file.
- description
User friendly description for the plug-in element.
- defaultValue
The default value of the plug-in element.
- assignedValue
The value assigned for the plug-in element in string format.
- listValues
If the plug-in element is of the type list, then this input specifies the values that are supported by the list. For example, if the plug-in element type is OTP, then the listValues would be Numeric, Alphabetic, or Alpha-Numeric.
- assignedValueBytes
The value assigned for the plug-in element in base64-encoded format.
|
|
events
|
No
|
An event is a pre-defined operation in the AuthMinder system. You must define the events that will invoke a configured plug-in. Use the following elements to configure the plug-in events:
- eventsSupported
The events supported by the plug-in.
- eventID
A numeric representation of the event. When associating an event with a plug-in, the eventID is required.
- eventName
A string representation of the event. When associating an event with a plug-in.
- eventsAvailable
For a given organization, the unused events that can be associated with a plug-in.
- eventID
A numeric representation of the event. When associating an event with a plug-in, the event ID is required.
- eventName
A string representation of the event. When associating an event with a plug-in, the eventName is not required.
- eventsAssociated
Events already associated with a plugin or those that are available for use.
- eventID
A numeric representation of the event. When associating an event with a plug-in, the eventID is required.
- eventName
A string representation of the event. When associating an event with a plug-in, the eventName is not required.
|
|
isTemplate
|
No
|
Indicates whether the plug-in information is to be read from a template.
|
