Administration Console Online Help

Previous Next Open TOC in new window
Content starts here

SQL Authenticator: Provider Specific

Configuration Options     Related Tasks     Related Topics

Use this page to define the provider specific configuration of this SQL Authentication provider.

Note the following:

Configuration Options

Name Description
Plaintext Passwords Enabled

Specifies whether plaintext passwords are allowed to be used.

MBean Attribute:
DBMSAuthenticatorMBean.PlaintextPasswordsEnabled

Data Source Name

The name of the JDBC data source used for database access.

Note: Specifying the JDBC data source is required.

MBean Attribute:
SQLAuthenticatorMBean.DataSourceName

Group Membership Searching

Specifies whether recursive group membership searching is unlimited or limited. Valid values are unlimited and limited.

MBean Attribute:
SQLAuthenticatorMBean.GroupMembershipSearching

Max Group Membership Search Level

This specifies how many levels of group membership can be searched. This setting is valid only if Group Membership Searching is set to limited. Valid values are 0 and positive integers. For example, 0 indicates only direct group memberships will be found, a positive number indicates the number of levels to go down.

MBean Attribute:
SQLAuthenticatorMBean.MaxGroupMembershipSearchLevel

Password Style Retained

Controls how a password is stored in the database when updating an existing user's password.

  • True indicates the password style and algorithm that were used for the original password in the database should be used for the new password. This setting is the default.

  • False indicates the settings for Password Algorithm and Password Style will be used for the new password.

MBean Attribute:
SQLAuthenticatorMBean.PasswordStyleRetained

Password Algorithm

The message digest algorithm used to hash passwords for storage. The name is a standard algorithm name and must be recognized by a Java Cryptography Extension (JCE) provider that is available at runtime. The Java Cryptography Architecture (JCA) defines the standard algorithm specifications.

MBean Attribute:
SQLAuthenticatorMBean.PasswordAlgorithm

Password Style

Indicates the password style that is used when storing passwords for users that are created and for changing the user's password if Password Style Retained is disabled.

MBean Attribute:
SQLAuthenticatorMBean.PasswordStyle

SQL Get Users Password

The SQL statement used to look up a user's password. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the password.

MBean Attribute:
SQLAuthenticatorMBean.SQLGetUsersPassword

SQL Set User Password

The SQL statement used to set the password for a user. The SQL statement requires two parameters: the password for the user and the username.

MBean Attribute:
SQLAuthenticatorMBean.SQLSetUserPassword

SQL User Exists

The SQL statement used to look up a user. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the user.

MBean Attribute:
SQLAuthenticatorMBean.SQLUserExists

SQL List Users

The SQL statement used to retrieve users that match a particular wildcard search The SQL statement requires a single parameter for the wildcarded usernames and returns a resultSet containing matching usernames

MBean Attribute:
SQLAuthenticatorMBean.SQLListUsers

SQL Create User

The SQL statement used to create a new user record. The SQL statement requirements depend on the value of Descriptions Supported. There is a minimum of two parameters: a username and its associated password. If Descriptions Supported is true, the user's description is required. The default SQL is based on the default setting of Descriptions Supported. The setting of Create User must be updated manually if the setting of Descriptions Supported changes.

MBean Attribute:
SQLAuthenticatorMBean.SQLCreateUser

SQL Remove User

The SQL statement used for deleting a user. The SQL statement requires a single parameter, the username.

MBean Attribute:
SQLAuthenticatorMBean.SQLRemoveUser

SQL List Groups

The SQL statement used to retrieve group names that match a wildcard The SQL statement requires a single parameter for the wildcarded group name and return a resultSet containing matching group names

MBean Attribute:
SQLAuthenticatorMBean.SQLListGroups

SQL Group Exists

The SQL statement used to look up a group. The SQL statement requires a single parameter for the group name and must return a resultSet containing at most a single record containing the group

MBean Attribute:
SQLAuthenticatorMBean.SQLGroupExists

SQL Create Group

The SQL statement used to create a new group. The SQL statement requirements depend on the value of Descriptions Supported. There is a minimum of one parameter, the group name. If Descriptions Supported is true, the group's description is required. The default SQL is based on the default setting of Descriptions Supported. The setting of Create Group must be updated manually if the setting of Descriptions Supported changes.

MBean Attribute:
SQLAuthenticatorMBean.SQLCreateGroup

SQL Remove Group

The SQL statement used to remove a member from a group. The SQL statement requires a single parameter: the group name being removed.

MBean Attribute:
SQLAuthenticatorMBean.SQLRemoveGroup

SQL Is Member

The SQL statement used to look up members of a group. The SQL statement requires two parameters: a group name and a member or group name. It must return a resultSet containing the group names that matched

MBean Attribute:
SQLAuthenticatorMBean.SQLIsMember

SQL List Member Groups

The SQL statement used to look up the groups a user or group is a member of. The SQL statement requires a single parameter for the username or group name and returns a resultSet containing the names of the groups that matched.

MBean Attribute:
SQLAuthenticatorMBean.SQLListMemberGroups

SQL List Group Members

The SQL statement used to list groups that have a group name with a list of wildcarded member names. The SQL statement requires two parameters: the group name and the wildcarded member name.

MBean Attribute:
SQLAuthenticatorMBean.SQLListGroupMembers

SQL Remove Group Memberships

The SQL statement used to delete a group member (either a user or group) from all groups to which it belongs. The SQL statement requires 2 parameters. Both parameters refer to the specific username or group name being removed.

MBean Attribute:
SQLAuthenticatorMBean.SQLRemoveGroupMemberships

SQL Add Member To Group

The SQL statement used to add a specific member to a group. The SQL statement requires two parameters: the group name and the group member being added.

MBean Attribute:
SQLAuthenticatorMBean.SQLAddMemberToGroup

SQL Remove Member From Group

The SQL statement used to remove a member from a group. The SQL statement requires two parameters: the group name and the group member being deleted from the group.

MBean Attribute:
SQLAuthenticatorMBean.SQLRemoveMemberFromGroup

SQL Remove Group Member

The SQL statement used to remove a member from a group. The SQL statement requires a single parameter: the username or group name being removed.

MBean Attribute:
SQLAuthenticatorMBean.SQLRemoveGroupMember

Descriptions Supported

Indicates whether user and group descriptions are supported by the database used by the authentication provider.

MBean Attribute:
SQLAuthenticatorMBean.DescriptionsSupported

SQL Get User Description

The SQL statement used to retrieve the description of a specific user. Only valid if Descriptions Supported is enabled. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the user description.

MBean Attribute:
SQLAuthenticatorMBean.SQLGetUserDescription

SQL Set Group Description

The SQL statement used to specify a description for a group. Only valid if Descriptions Supported attribute is enabled. The SQL statement requires two parameters: the group description and the group name.

MBean Attribute:
SQLAuthenticatorMBean.SQLSetGroupDescription

SQL Get Group Description

The SQL statement used to retrieve the description of a group. Only valid if Descriptions Supported is enabled. The SQL statement requires a single parameter for the group name and must return a resultSet containing at most a single record containing the group description.

MBean Attribute:
SQLAuthenticatorMBean.SQLGetGroupDescription

SQL Set Group Description

The SQL statement used to specify a description for a group. Only valid if Descriptions Supported attribute is enabled. The SQL statement requires two parameters: the group description and the group name.

MBean Attribute:
SQLAuthenticatorMBean.SQLSetGroupDescription

Related Tasks

Related Topics


Back to Top