API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create the management users list

Management user parameter configuration.
For AP, Users from higher-level configurations are automatically inherited and displayed at lower levels.
When a lower-level user has the same role name as a higher-level user, the lower-level user takes precedence.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Unique name for the given username on the device, which may either be the same as or different from the username.

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

userbody object

int32
1 to 365

Password aging time for a user.

authorized-key
array of objects
length ≤ 2147483647

Public keys for SSH authentication of a user

authorized-key
string
length between 1 and 256

Management user password in hash or ciphertext.

string
enum

Enable clear, cipher or hash text as the password input format.
For AP, Range: CLEARTEXT, CIPHERTEXT.

Show Details
CIPHERTEXTUser password in encrypted format
CLEARTEXTUser password in cleartext format.
SHA1User password in SHA1 hash format
SHA256User password in SHA256 hash format
Allowed:
interface
object

The management interfaces through which the user can access the switch.

int32
0 to 32

Maximum concurrent session for this management user. A value of 0 will unset it.

int32
8 to 64

Minimum password length for a user.

string
length between 1 and 128

Unique name for the given username on the device, which may either be the same as or different from the username.

string
length ≤ 9999

Management user's old password.

string
length ≤ 9999

Management user password in plaintext.

  • For a CX device, Maximum length is 64 characters.
    If not configured, it indicates that the user is created with an empty password
string
enum

Configure user-role. For example, user with read-only privilege or the guest management user.

Show Details
AP_PROVISIONINGAP Provisioning role
GUEST_PROVISIONINGGuest provisioning role
LOCALIndicate the type of management users with local privilege.
LOCATION_API_MGMTLocation API Management role
NBAPI_MGMTNBAPI Management role
NETWORK_OPERATIONSNetwork operator role
READ_ONLYRead-only role
ROOTSuper user role
STANDARDStandard role
string
length between 1 and 32

Management user group name.

  • For a CX device, user group is mandatory for creating a user.
    Built-in user groups are as follows:
    administrators: System-defined group with associated privilege level of 15.
    Members have access to:
    All the CLI commands and bash shell.
    All the REST Methods through REST APIs.
    operators: System-defined group with associated privilege level of 1.
    Members have access to
    All show CLI commands (except those that display sensitive information).
    All GET requests through REST APIs.
    auditors: System-defined group with associated privilege level of 19.
    Members have access to:
    All show CLI commands to display and copy security logs.
    All GET requests for security logs through REST APIs.
    Only users belonging to the above three default groups will be allowed access to REST APIs.
string
length between 1 and 128

Username of the management user.

  • For a CX device, Maximum length is 32 characters.
  • For a PVOS device, valid length is 1..16.
  • For AP, valid length is 1..32.
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json