Management::UserManagement¶
Introduced : BIG-IP_v9.0
The UserManagement interface deals with adding/deleting and modifying
users and user permission.
Methods¶
| Method | Description | Introduced |
| change_my_password | Change the password of the user making the request. | BIG-IP_v9.4.0 |
| change_password | Change the user&aposs password. | BIG-IP_v9.0 |
| change_password_2 | Change the user&aposs password. | BIG-IP_v9.4.0 |
| create_user | Note: this method is deprecated; please use create_user_3 and associated data. (home directory, user id, and group id are now computed by the system, and there is now a choice of whether the password is encrypted) Create the specified new users. Note: as of v10.1.0, this method will silently ignore any of user id, group id, and home directory passed in. | BIG-IP_v9.0 |
| create_user_2 | Note: this method is deprecated; please use create_user_3 and associated data. (home directory, user id, and group id are now computed by the system) Create the specified new users. Note: as of v10.1.0, this method will silently ignore any of user id, group id, and home directory passed in. | BIG-IP_v9.4.0 |
| create_user_3 | Create the specified new users. | BIG-IP_v10.1.0 |
| delete_user | Delete the specified users. | BIG-IP_v9.0 |
| delete_user_permission | Delete the permissions of the specified users. The permission basically indicates what role a user has on a given partition. A user could have one role on a partition, and a different role on another partition, hence the permission list is a sequence of sequence. | BIG-IP_v11.6.0 |
| get_authentication_method | Get the authentication method that the system will use to authenticate users. | BIG-IP_v9.4.0 |
| get_default_partition | Get the default user partition for the device. | BIG-IP_v9.4.2 |
| get_default_role | Get the default user role for the device. | BIG-IP_v9.4.0 |
| get_description | Gets the descriptions for a set of users. | BIG-IP_v11.0.0 |
| get_encrypted_password | Gets the encrypted passwords of the specified users. | BIG-IP_v9.4.0 |
| get_fallback | Get the setting for fallback to local for remote authentication. | BIG-IP_v13.0.0 |
| get_fullname | Get the full names for the given users. | BIG-IP_v9.4.0 |
| get_group_id | Get the Group IDs for the given usernames. | BIG-IP_v9.0 |
| get_home_directory | Get the default home directories for the given usernames. | BIG-IP_v9.0 |
| get_home_partition | Gets the home partitions of the specified users. This method gets the partition the user is defined in, rather than the partition a user may have a role in. | BIG-IP_v10.2.3 |
| get_list | List all users. | BIG-IP_v9.0 |
| get_login_shell | Get the login shells for the given usernames. | BIG-IP_v9.0 |
| get_my_permission | Gets the credentials of the user making the request. This is useful in getting your own permission information (regardless of which partitions you may otherwise read). The results indicate what role you have on a what partitions. | BIG-IP_v9.4.0 |
| get_remote_console_access | Get the user remote console access for the device. | BIG-IP_v9.4.2 |
| get_role | This method is now deprecated. Please use get_user_permission in its stead, which uses a larger concept of user roles. Gets the roles of the specified users. | BIG-IP_v9.0 |
| get_user_id | Get the User IDs for the given usernames. | BIG-IP_v9.0 |
| get_user_permission | Gets the permissions of the specified users. The permission basically indicates what role a user has on a given partition. A user could have one role on a partition, and a different role on another partition, hence the return list is a sequence of sequence. | BIG-IP_v9.4.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| is_locked_out | Checks to see if a user is locked out due to exceeding the maximum number of allowed login failures. Return whether the user is locked out. | BIG-IP_v10.2.0 |
| reset_locked_out | Resets the lockout status of a user that has exceeded the maximum number of allowed login failures. Unlocks all users provided in user_names unless an error occurs where it may unlock up to that user that caused the error. | BIG-IP_v10.2.0 |
| set_authentication_method | Sets the authentication method that the system will use to authenticate users. | BIG-IP_v9.4.0 |
| set_default_partition | Sets the default user partition for the device if the user does not have an explicit partition. | BIG-IP_v9.4.2 |
| set_default_role | Sets the default user role for the device if the user does not have an explicit role. | BIG-IP_v9.4.0 |
| set_description | Sets the description for a set of users. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_fallback | Set whether or not to use fallback to local for remote authentication. | BIG-IP_v13.0.0 |
| set_fullname | Sets the full names for the specified users. | BIG-IP_v9.4.0 |
| set_group_id | This method is deprecated, as the operation is not allowed (and will return an error). Sets the Group IDs for the specified users. | BIG-IP_v9.0 |
| set_home_directory | This method is deprecated, as the operation is not allowed (and will return an error). Sets the home directories for the specified users. | BIG-IP_v9.0 |
| set_login_shell | Sets the login shells for the specified users. | BIG-IP_v9.0 |
| set_remote_console_access | Sets the user remote console access for the device if the user does not have an explicit remote console access. | BIG-IP_v9.4.2 |
| set_role | This method is now deprecated. Please use set_user_permission in its stead, which uses a larger concept of user roles. Change the user&aposs role. | BIG-IP_v9.0 |
| set_user_id | This method is deprecated, as the operation is not allowed (and will return an error). Sets the User IDs for the specified users. | BIG-IP_v9.0 |
| set_user_permission | Sets the permissions of the specified users. The permission basically indicates what role a user has on a given partition. A user could have one role on a partition, and a different role on another partition, hence the permission list is a sequence of sequence. | BIG-IP_v9.4.0 |
Structures¶
Structure
Description
The user&aposs password.
A struct that describes a user.
Note: this type is deprecated; please use UserInfo3 and associated methods. (home directory, user id, and group id are now computed by the system) UserInfo is used to store user information.
Note: this type is deprecated; please use UserInfo3 and associated methods. (home directory, user id, and group id are now computed by the system) UserInfo2 is used to store user information.
UserInfo3 is used to store user information.
A struct that describes a user permission. This indicates what role a user has on a given partition.
Enumerations¶
| Enumeration | Description |
| UserRole | An enumerated type that contains the possible roles a user may have. Refer to the product manual for a complete list of what each role means. |
Aliases¶
| Alias | Type | Description |
| PasswordInfoSequence | PasswordInfo [] | An alias for a sequence of PasswordInfo |
| UserIDSequence | UserID [] | A sequence of UserIDs. |
| UserInfo2Sequence | UserInfo2 [] | Note: this type is deprecated; please use UserInfo3 and associated methods. An alias for a sequence of UserInfo |
| UserInfo3Sequence | UserInfo3 [] | An alias for a sequence of UserInfo3 |
| UserInfoSequence | UserInfo [] | Note: this type is deprecated; please use UserInfo3 and associated methods. An alias for a sequence of UserInfo |
| UserPermissionSequence | UserPermission [] | A sequence of UserPermissions. |
| UserPermissionSequenceSequence | UserPermission [] [] | An alias for a sequence of UserPermissions. |
| UserRoleSequence | UserRole [] | An alias for a sequence of UserRole |
| UserRoleSequenceSequence | UserRole [] [] | An alias for a sequence of UserRoleSequence |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.