APIRef_tm_auth_user¶
mgmt/tm/auth/user
Manage user accounts
REST Endpoints
- Collection URI
/mgmt/tm/auth/user- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/auth/user/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
description |
string | optional | read/write | User defined description. | |
encryptedPassword |
string | optional | read/write | Displays the encrypted password for the user account. | |
tmPartition |
string | optional | read/write | Displays the administrative partition within which the user account resides. | |
password |
string | optional | read/write | Set the user password during creation or modification without prompting or confirmation. May not be used with prompt-for-password. Passwords are hidden in log and history files. | |
promptForPassword |
boolean | optional | read/write | Specifies that the BIG-IP system prompt the administrator or user manager for a password and password confirmation for the account when the account is created or modified. | |
shell |
string | optional | read/write | Specifies the shell to which the user has access. Valid values are bash (unrestricted system access), none (no shell access, user must use the Configuration utility), or tmsh (TMOS shell). |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/partition-access |
array_structure | optional | read/write | ||
/partition-access/role |
string | admin | optional | read/write |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
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.