# UserEditorMBean (Abstract)

Overview | Related MBeans | Attributes | Operations

## Overview

Provides a set of methods for creating, editing, and removing users. An Authentication provider MBean can optionally implement this MBean. The WebLogic Server Administration Console detects when an Authentication provider implements this MBean and automatically provides a GUI for using these methods.

Fully Qualified Interface Name | If you use the `getMBeanInfo` operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name: `weblogic.management.security.authentication.UserEditorMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Subtypes | The following MBeans extend or implement this MBean type:
DefaultAuthenticatorMBean SQLAuthenticatorMBean |

## Operations

This section describes the following operations:

advance changeUserPassword close createUser getCurrentName getUserDescription haveCurrent | listUsers removeUser resetUserPassword setUserDescription userExists wls_getDisplayName

### advance

Advances the list to the next element in the list.

Operation Name | `"advance"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor returned from a previous list method.
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### changeUserPassword

Used by a user to change his or her password.

Operation Name | `"changeUserPassword"`
Parameters | `Object [] { userName, oldPassword, newPassword }` where: `userName` is an object of type `java.lang.String` that specifies: - The name of an existing user. `oldPassword` is an object of type `java.lang.String` that specifies: - The current password for the user. `newPassword` is an object of type `java.lang.String` that specifies: - The new password for the user. The Authentication provider determines the syntax requirements for passwords.
Signature | `String [] { "java.lang.String", "java.lang.String", "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### close

Indicates that the caller is finished using the list, and that the resources held on behalf of the list may be released. If the caller traverses through all the elements in the list, the caller need not call this method. In other words, it is used to let the caller close the list without reading each element that is returned.

Operation Name | `"close"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor returned from a previous list method.
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### createUser

Creates a user and sets the user's password.

Operation Name | `"createUser"`
Parameters | `Object [] { userName, password, description }` where: `userName` is an object of type `java.lang.String` that specifies: - The name of the new user. The name cannot be the name of an existing user or group. The Authentication provider determines syntax requirements for the user name. `password` is an object of type `java.lang.String` that specifies: - The password for the new user. The Authentication provider determines syntax requirements for passwords. `description` is an object of type `java.lang.String` that specifies: - The description of the user.
Signature | `String [] { "java.lang.String", "java.lang.String", "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.InvalidParameterException` `weblogic.management.utils.AlreadyExistsException`

### getCurrentName

The name of the current item in the list. Returns null if there is no current item.

Operation Name | `"getCurrentName"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor returned from a previous list method.
Signature | `String [] { "java.lang.String" }`
Returns | `String`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### getUserDescription

Gets a user's description.

Operation Name | `"getUserDescription"`
Parameters | `Object [] { userName }` where: `userName` is an object of type `java.lang.String` that specifies: - The name of an existing user.
Signature | `String [] { "java.lang.String" }`
Returns | `String`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### haveCurrent

Returns true if there are more objects in the list, and false otherwise.

Operation Name | `"haveCurrent"`
Parameters | `Object [] { cursor }` where: `cursor` is an object of type `java.lang.String` that specifies: - The cursor returned from a previous list method.
Signature | `String [] { "java.lang.String" }`
Returns | `boolean`
Exceptions | `weblogic.management.utils.InvalidCursorException`

### listUsers

Searches for a user name that matches a pattern.

This method returns a cursor that you can pass to the methods from `weblogic.management.utils.NameListerMBean` (which this MBean extends) to iterate through the returned list.

This method does not sort the results.

Operation Name | `"listUsers"`
Parameters | `Object [] { userNameWildcard, maximumToReturn }` where: `userNameWildcard` is an object of type `java.lang.String` that specifies: - The pattern for which this method searches. The pattern can end with an `*` (asterisk) as a wildcard, which matches any string of characters. The search is not case-sensitive. For example, a pattern of `abc` matches exactly one user name that contains only `abc`, a pattern of `ab*` matches all user names that start with `ab`, and a pattern of `*` matches all user names. `maximumToReturn` is an object of type `java.lang.Integer` that specifies: - The maximum number of user names that this method returns. If there are more matches than this maximum, then the returned results are arbitrary because this method does not sort results. If the parameter is set to 0 there is no maximum and all results are returned.
Signature | `String [] { "java.lang.String", "java.lang.Integer" }`
Returns | `String`
Exceptions | `weblogic.management.utils.InvalidParameterException`

### removeUser

Removes a user.

Operation Name | `"removeUser"`
Parameters | `Object [] { userName }` where: `userName` is an object of type `java.lang.String` that specifies: - The name of an existing user.
Signature | `String [] { "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### resetUserPassword

Used by an administrator to change a user's password.

Operation Name | `"resetUserPassword"`
Parameters | `Object [] { userName, newPassword }` where: `userName` is an object of type `java.lang.String` that specifies: - The name of an existing user. `newPassword` is an object of type `java.lang.String` that specifies: - The new password for the user. The Authentication provider determines the syntax requirements for passwords.
Signature | `String [] { "java.lang.String", "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### setUserDescription

Sets the description for an existing user.

Operation Name | `"setUserDescription"`
Parameters | `Object [] { userName, description }` where: `userName` is an object of type `java.lang.String` that specifies: - The name of an existing user. `description` is an object of type `java.lang.String` that specifies: - The description of the user.
Signature | `String [] { "java.lang.String", "java.lang.String" }`
Returns | `void`
Exceptions | `weblogic.management.utils.NotFoundException` `weblogic.management.utils.InvalidParameterException`

### userExists

Indicates whether the specified user exists.

Operation Name | `"userExists"`
Parameters | `Object [] { userName }` where: `userName` is an object of type `java.lang.String` that specifies: - The name that this method evaluates.
Signature | `String [] { "java.lang.String" }`
Returns | `boolean`
Exceptions | `weblogic.management.utils.InvalidParameterException`

### wls_getDisplayName

Operation Name | `"wls_getDisplayName"`
Parameters | `null`
Signature | `null`
Returns | `String`